COMMERCE QUERY
/
Query API 3.0
/
Products

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Gets all product SKUs.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/ProductSkus \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product SKUs.

Bodyapplication/jsonArray [
partNostring or null[ 0 .. 50 ] characters

The part number.

clientIdinteger(int32)

The client identifier.

productIdinteger(int32)

The product identifier.

statusIdinteger(int32)

The status identifier, Active (1), Coming (2), Expiring (3), Hidden (4), Inactive (5).

statusLastUpdatedstring or null(date-time)

The status last updated.

statusLastUpdatedByinteger or null(int32)

The status last updated by.

typeIdinteger(int32)

The type identifier, a value from the ClientProductSkuType.

integrationPartNostring or null[ 0 .. 50 ] characters

The integration part number, used when ERP has a different part number or a shared part number for many products in the Norce.

erpNamestring or null[ 0 .. 255 ] characters

The ERP name.

defaultCommentstring or null[ 0 .. 255 ] characters

The default comment.

commodityCodestring or null[ 0 .. 50 ] characters

The commodity code.

eanCodestring or null[ 0 .. 50 ] characters

The EAN code.

trackingCodestring or null[ 0 .. 50 ] characters

The tracking code.

grossWeightnumber or null(decimal)

The gross weight, called Actual weight in the admin tool and is used by shipping calculations.

netWeightnumber or null(decimal)

The net weight, not commonly used, set up parametrics instead.

freightClassIdinteger or null(int32)

The freight class identifier, not used anymore.

unitOfMeasurementIdinteger or null(int32)

The unit of measurement identifier.

unitOfMeasurementCountnumber(decimal)

The unit of measurement count.

packageIdinteger or null(int32)

The package identifier, not used anymore.

trackingCodeTypeIdinteger or null(int32)

The tracking code type identifier, not used anymore.

urlstring or null[ 0 .. 255 ] characters

The URL.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

isDropShipOnlyboolean or null

Indicates whether the client product sku is drop ship only.

isPublishedboolean

Indicates whether the client product sku is published, not used anymore.

publishedLastUpdatedstring or null(date-time)

The published last updated.

publishedLastUpdatedByinteger or null(int32)

The published last updated by.

isBlockedboolean

Indicates whether the client product sku is blocked, 1 can force block a sku from being shown outside the system, but is not used anymore.

blockedLastUpdatedstring or null(date-time)

The blocked last updated.

blockedLastUpdatedByinteger or null(int32)

The blocked last updated by.

populationRuleIdinteger or null(int32)

The population rule identifier, not used anymore.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

lastCheckedstring or null(date-time)

The last checked.

trackingModeTypeIdinteger or null(int32)

The tracking mode type identifier, not used anymore.

isStatusLockedboolean

Indicates whether the client product sku is status locked, can be set manually in the admin tool.

statusLockedDatestring or null(date-time)

The status locked date.

statusLockedByinteger or null(int32)

The status locked by.

recommendedSalesQtynumber or null(decimal)

The recommended sales quantity.

logisticWidthnumber or null(decimal)

The logistic width, used in logistics calculations.

logisticHeightnumber or null(decimal)

The logistic height, used in logistics calculations.

logisticDepthnumber or null(decimal)

The logistic depth, used in logistics calculations.

isBuyableboolean

Indicates whether the client product sku is buyable, if 0 the cannot be added to baskets.

buyableLastUpdatedstring or null(date-time)

The buyable last updated.

buyableLastUpdatedByinteger or null(int32)

The buyable last updated by.

discountClassstring or null[ 0 .. 50 ] characters

The discount class, not used anymore.

isRecommendedSalesQtyFixedboolean or null

Indicates whether the client product sku is recommended sales quantity fixed.

startDatestring or null(date-time)

The start date, indicated when a coming product switches to active.

endDatestring or null(date-time)

The end date, indicated when an expiring product switches to inactive.

culturesArray of objects or null(ClientProductSkuCulture)
onHandsArray of objects or null(ClientProductSkuOnHand)
priceListsArray of objects or null(ClientProductSkuPriceList)
salesAreasArray of objects or null(ClientProductSkuSalesArea)
structureItemsArray of objects or null(ClientProductSkuStructureItem)
bestPricesArray of objects or null(ClientProductSkuBestPrice)
product(Product (object or null))
One of:
]
Response
application/json
[
  {
    "partNo": "string",
    "clientId": 0,
    "productId": 0,
    "statusId": 0,
    "statusLastUpdated": "2019-08-24T14:15:22Z",
    "statusLastUpdatedBy": 0,
    "typeId": 0,
    "integrationPartNo": "string",
    "erpName": "string",
    "defaultComment": "string",
    "commodityCode": "string",
    "eanCode": "string",
    "trackingCode": "string",
    "grossWeight": 0,
    "netWeight": 0,
    "freightClassId": 0,
    "unitOfMeasurementId": 0,
    "unitOfMeasurementCount": 0,
    "packageId": 0,
    "trackingCodeTypeId": 0,
    "url": "string",
    "imagePath": "string",
    "isDropShipOnly": true,
    "isPublished": true,
    "publishedLastUpdated": "2019-08-24T14:15:22Z",
    "publishedLastUpdatedBy": 0,
    "isBlocked": true,
    "blockedLastUpdated": "2019-08-24T14:15:22Z",
    "blockedLastUpdatedBy": 0,
    "populationRuleId": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lastChecked": "2019-08-24T14:15:22Z",
    "trackingModeTypeId": 0,
    "isStatusLocked": true,
    "statusLockedDate": "2019-08-24T14:15:22Z",
    "statusLockedBy": 0,
    "recommendedSalesQty": 0,
    "logisticWidth": 0,
    "logisticHeight": 0,
    "logisticDepth": 0,
    "isBuyable": true,
    "buyableLastUpdated": "2019-08-24T14:15:22Z",
    "buyableLastUpdatedBy": 0,
    "discountClass": "string",
    "isRecommendedSalesQtyFixed": true,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "cultures": [ … ],
    "onHands": [ … ],
    "priceLists": [ … ],
    "salesAreas": [ … ],
    "structureItems": [ … ],
    "bestPrices": [ … ],
    "product": { … }
  }
]

Gets all products.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/Products \
  -H 'ApplicationId: 0'

Responses

A queryable collection of products.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the product.

clientIdinteger(int32)

The client identifier.

manufacturerIdinteger(int32)

The manufacturer identifier.

manufacturerPartNostring[ 0 .. 50 ] charactersrequired

The manufacturer part number.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the product.

defaultSubHeaderstring or null[ 0 .. 255 ] characters

The default sub header.

defaultSubDescriptionstring or null

The default sub description.

defaultDescriptionHeaderstring or null[ 0 .. 255 ] characters

The default description header.

defaultDescriptionstring or null

The default description of the product.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

defaultSynonymsstring or null[ 0 .. 500 ] characters

The default synonyms, commonly comma or blank space separated list of words.

sortOrderValueinteger or null(int32)

The sort order, not commonly used.

assortmentIdinteger or null(int32)

The assortment identifier, not commonly used.

assortmentLastUpdatedstring or null(date-time)

The assortment last updated, not commonly used.

assortmentLastUpdatedByinteger or null(int32)

The assortment last updated by, not commonly used.

isVariantboolean

Indicates whether the product is variant.

variantIdinteger or null(int32)

The variant identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias, not commonly used.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title, for SEO purposes.

defaultTagsstring or null

The default tags, not commonly used.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

hideInTopListboolean or null

Indicates whether product is hidden in rankings like popularity logic.

isActiveboolean

Indicates whether the product is active.

stoppedDatestring or null(date-time)

The stopped date, set automatically when the product is disabled or deactivated.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

insuranceCurrencyIdinteger or null(int32)

The insurance currency identifier, not commonly used.

insuranceStartPricenumber or null(decimal)

The insurance start price, not commonly used.

insuranceRunningPercentagenumber or null(decimal)

The insurance running percentage, not commonly used.

keystring(guid)

The key.

manufacturerPartNo2string or null[ 0 .. 50 ] characters

The manufacturer part no2, not commonly used.

imageKeystring or null(guid)

The image key.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name, a unique URL friendly name for the product, called UniqueName in the admin tool.

stockDisplayBreakPointinteger or null(int32)

The stock display break point, used for determining when to display stock information.

isDangerousGoodsboolean

Indicates whether the product is dangerous goods, used by shipping logic.

codestring or null[ 0 .. 50 ] characters

The common code for variants. All products with same code are considered variants of each other, if left out the product is considered standalone.

isRecurringOrderableboolean or null

Indicates whether the product is recurring orderable, not commonly used.

defaultExternalDescriptionstring or null

The default external description, not commonly used.

unspscCodestring or null[ 0 .. 50 ] characters

The unspsc code, overrides the value from the primary category.

translationRequestedstring or null(date-time)

Indicates if a 3rd party translation has been requested.

translationRequestedByinteger or null(int32)

The translation requested by.

defaultImageAltTextstring or null

The default image alt text.

flagsArray of objects or null(ClientProductFlag)
skusArray of objects or null(ClientProductSku)
categoriesArray of objects or null(ProductCategory)
culturesArray of objects or null(ProductCulture)
familiesArray of objects or null(ProductFamily)
filesArray of objects or null(ProductFile)
parametricsArray of objects or null(ProductParametric)
parametricMultipleArray of objects or null(ProductParametricMultiple)
productRelationsArray of objects or null(ProductRelation)
productRelationRelatedProductArray of objects or null(ProductRelation)
supplierSkusArray of objects or null(SupplierProductSkuClient)
variant(Variant (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "manufacturerId": 0,
    "manufacturerPartNo": "string",
    "defaultName": "string",
    "defaultSubHeader": "string",
    "defaultSubDescription": "string",
    "defaultDescriptionHeader": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "defaultSynonyms": "string",
    "sortOrderValue": 0,
    "assortmentId": 0,
    "assortmentLastUpdated": "2019-08-24T14:15:22Z",
    "assortmentLastUpdatedBy": 0,
    "isVariant": true,
    "variantId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "hideInTopList": true,
    "isActive": true,
    "stoppedDate": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "insuranceCurrencyId": 0,
    "insuranceStartPrice": 0,
    "insuranceRunningPercentage": 0,
    "key": "string",
    "manufacturerPartNo2": "string",
    "imageKey": "string",
    "defaultUniqueUrlName": "string",
    "stockDisplayBreakPoint": 0,
    "isDangerousGoods": true,
    "code": "string",
    "isRecurringOrderable": true,
    "defaultExternalDescription": "string",
    "unspscCode": "string",
    "translationRequested": "2019-08-24T14:15:22Z",
    "translationRequestedBy": 0,
    "defaultImageAltText": "string",
    "flags": [ … ],
    "skus": [ … ],
    "categories": [ … ],
    "cultures": [ … ],
    "families": [ … ],
    "files": [ … ],
    "parametrics": [ … ],
    "parametricMultiple": [ … ],
    "productRelations": [ … ],
    "productRelationRelatedProduct": [ … ],
    "supplierSkus": [ … ],
    "variant": { … }
  }
]

Gets all product SKU price lists.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/ProductSkuPriceLists \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product SKU price lists.

Bodyapplication/jsonArray [
partNostring or null[ 0 .. 50 ] characters

The part number.

clientIdinteger(int32)

The client identifier.

priceListIdinteger(int32)

The price list identifier.

qtyBreakinteger(int32)

The quantity break, default is 1.

currencyIdinteger(int32)

The currency identifier.

priceSalenumber(decimal)

The price sale, calculated based on the fields in this record, depending on the price rule.

priceSaleLastUpdatedstring or null(date-time)

The price sale last updated.

priceSaleLastUpdatedByinteger or null(int32)

The price sale last updated by.

priceRuleIdinteger or null(int32)

The price rule identifier.

priceRuleValuenumber or null(decimal)

The price rule value, depending on the price rule can contain like margin or uplift in percent, discount in percent or fixed amount, null when fixed price rule.

costPurchasenumber(decimal)

The cost purchase.

costPurchaseLastUpdatedstring or null(date-time)

The cost purchase last updated.

costPurchaseLastUpdatedByinteger or null(int32)

The cost purchase last updated by.

costUnitnumber(decimal)

The cost unit.

costUnitLastUpdatedstring or null(date-time)

The cost unit last updated.

costUnitLastUpdatedByinteger or null(int32)

The cost unit last updated by.

supplementChargePercentagenumber or null(decimal)

The supplement charge percentage.

priceStandardnumber or null(decimal)

The price standard, inherited from the parent price list record, otherwise null.

priceRecommendednumber or null(decimal)

The price recommended.

priceRecommendedLastUpdatedstring or null(date-time)

The price recommended last updated.

priceRecommendedLastUpdatedByinteger or null(int32)

The price recommended last updated by.

pricePreviousnumber or null(decimal)

The price previous, can contain historical best price, if functionality is enabled for the client.

pricePreviousLastUpdatedstring or null(date-time)

The price previous last updated.

pricePreviousLastUpdatedByinteger or null(int32)

The price previous last updated by.

priceCatalognumber or null(decimal)

The price catalog.

priceCatalogLastUpdatedstring or null(date-time)

The price catalog last updated.

priceCatalogLastUpdatedByinteger or null(int32)

The price catalog last updated by.

isPriceDiscountableboolean

Indicates whether the client product sku price list is price discountable by promotions.

chosenSupplierIdinteger or null(int32)

The chosen supplier identifier.

chosenSupplierPartNostring or null[ 0 .. 50 ] characters

The chosen supplier part number.

chosenSupplierPriceListIdinteger or null(int32)

The chosen supplier price list identifier.

chosenSupplierQtyBreakinteger or null(int32)

The chosen supplier quantity break.

isChosenSupplierLockedboolean

Indicates whether the client product sku price list is chosen supplier locked, not used anymore.

isActiveboolean

Indicates whether the client product sku price list is active.

stoppedDatestring or null(date-time)

The stopped date.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

lastCheckedstring or null(date-time)

The last checked.

minimumMarginPercentagenumber or null(decimal)

The minimum margin percentage.

priceRuleLastUpdatedstring or null(date-time)

The price rule last updated.

priceRuleLastUpdatedByinteger or null(int32)

The price rule last updated by.

pricingIdinteger or null(int32)

The pricing identifier, not used anymore.

supplementChargenumber or null(decimal)

The supplement charge.

limitToPriceRecommendedboolean or null

Indicates whether limit to price recommended is enabled.

isActiveLastUpdatedstring or null(date-time)

The is active last updated.

isActiveLastUpdatedByinteger or null(int32)

The is active last updated by.

sku(ClientProductSku (object or null))
One of:
infoArray of objects or null(ClientProductSkuPriceListInfo)
priceList(PriceList (object or null))
One of:
]
Response
application/json
[
  {
    "partNo": "string",
    "clientId": 0,
    "priceListId": 0,
    "qtyBreak": 0,
    "currencyId": 0,
    "priceSale": 0,
    "priceSaleLastUpdated": "2019-08-24T14:15:22Z",
    "priceSaleLastUpdatedBy": 0,
    "priceRuleId": 0,
    "priceRuleValue": 0,
    "costPurchase": 0,
    "costPurchaseLastUpdated": "2019-08-24T14:15:22Z",
    "costPurchaseLastUpdatedBy": 0,
    "costUnit": 0,
    "costUnitLastUpdated": "2019-08-24T14:15:22Z",
    "costUnitLastUpdatedBy": 0,
    "supplementChargePercentage": 0,
    "priceStandard": 0,
    "priceRecommended": 0,
    "priceRecommendedLastUpdated": "2019-08-24T14:15:22Z",
    "priceRecommendedLastUpdatedBy": 0,
    "pricePrevious": 0,
    "pricePreviousLastUpdated": "2019-08-24T14:15:22Z",
    "pricePreviousLastUpdatedBy": 0,
    "priceCatalog": 0,
    "priceCatalogLastUpdated": "2019-08-24T14:15:22Z",
    "priceCatalogLastUpdatedBy": 0,
    "isPriceDiscountable": true,
    "chosenSupplierId": 0,
    "chosenSupplierPartNo": "string",
    "chosenSupplierPriceListId": 0,
    "chosenSupplierQtyBreak": 0,
    "isChosenSupplierLocked": true,
    "isActive": true,
    "stoppedDate": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lastChecked": "2019-08-24T14:15:22Z",
    "minimumMarginPercentage": 0,
    "priceRuleLastUpdated": "2019-08-24T14:15:22Z",
    "priceRuleLastUpdatedBy": 0,
    "pricingId": 0,
    "supplementCharge": 0,
    "limitToPriceRecommended": true,
    "isActiveLastUpdated": "2019-08-24T14:15:22Z",
    "isActiveLastUpdatedBy": 0,
    "sku": { … },
    "info": [ … ],
    "priceList": { … }
  }
]

Shopping

Operations

Metadata

Operations