COMMERCE QUERY
/
Query API 3.0
/
Products
/
Gets all product variants.

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 supplier product SKUs.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of supplier product SKUs.

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

The supplier part number.

supplierIdinteger(int32)

The supplier identifier.

namestring or null[ 0 .. 500 ] characters

The name of the supplier product sku.

manufacturerIdinteger or null(int32)

The manufacturer identifier.

manufacturerCodestring or null[ 0 .. 50 ] characters

The manufacturer code.

manufacturerPartNostring or null[ 0 .. 50 ] characters

The manufacturer part number.

categoryIdinteger or null(int32)

The category identifier.

categoryCodestring or null[ 0 .. 255 ] characters

The category code.

commodityCodestring or null[ 0 .. 50 ] characters

The commodity code.

eanCodestring or null[ 0 .. 50 ] characters

The EAN code.

grossWeightnumber or null(decimal)

The gross weight.

netWeightnumber or null(decimal)

The net weight.

vatCodeIdinteger or null(int32)

The vat code identifier.

unitOfMeasurementIdinteger(int32)

The unit of measurement identifier.

unitOfMeasurementCountnumber(decimal)

The unit of measurement count.

urlstring or null[ 0 .. 255 ] characters

The URL. Not commonly used.

imagePathstring or null[ 0 .. 255 ] characters

The image path. 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.

imagePathLastUpdatedstring or null(date-time)

The image path last updated. Not used anymore.

isUsedboolean

Indicates whether the supplier product sku is refurbished. Not commonly used.

logisticWidthnumber or null(decimal)

The logistic width.

logisticHeightnumber or null(decimal)

The logistic height.

logisticDepthnumber or null(decimal)

The logistic depth.

clientIdinteger or null(int32)

The client identifier.

productIdinteger or null(int32)

The product identifier.

supplierProductSkuClientArray of objects or null(SupplierProductSkuClient)
onHandsArray of objects or null(SupplierProductSkuOnHand)
priceListsArray of objects or null(SupplierProductSkuPriceList)
]
Response
application/json
[
  {
    "partNo": "string",
    "supplierId": 0,
    "name": "string",
    "manufacturerId": 0,
    "manufacturerCode": "string",
    "manufacturerPartNo": "string",
    "categoryId": 0,
    "categoryCode": "string",
    "commodityCode": "string",
    "eanCode": "string",
    "grossWeight": 0,
    "netWeight": 0,
    "vatCodeId": 0,
    "unitOfMeasurementId": 0,
    "unitOfMeasurementCount": 0,
    "url": "string",
    "imagePath": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imagePathLastUpdated": "2019-08-24T14:15:22Z",
    "isUsed": true,
    "logisticWidth": 0,
    "logisticHeight": 0,
    "logisticDepth": 0,
    "clientId": 0,
    "productId": 0,
    "supplierProductSkuClient": [ … ],
    "onHands": [ … ],
    "priceLists": [ … ]
  }
]

Gets all product variants.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of product variants.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the variant.

clientIdinteger(int32)

The client identifier.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the variant.

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.

groupIdinteger or null(int32)

The VariantGroup identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias. Not used anymore.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title. For SEO purposes.

defaultTagsstring or null

The default tags, not commonly used anymore.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

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.

imageKeystring or null(guid)

The image key.

codestring or null[ 0 .. 50 ] characters

The code of the variant. Grouping variants together.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name.

keystring(guid)

The key. Not used anymore.

defaultImageAltTextstring or null

The default image alt text.

variantGroup(VariantGroup (object or null))
One of:
productsArray of objects or null(Product)
culturesArray of objects or null(VariantCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "groupId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "code": "string",
    "defaultUniqueUrlName": "string",
    "key": "string",
    "defaultImageAltText": "string",
    "variantGroup": { … },
    "products": [ … ],
    "cultures": [ … ]
  }
]

Gets all product best prices logs.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of product best prices history logs.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the client product sku best price.

partNostring[ 0 .. 50 ] charactersrequired

The part number.

applicationIdinteger(int32)

The application identifier.

qtyBreakinteger(int32)

The quantity break.

clientIdinteger(int32)

The client identifier.

priceListIdinteger(int32)

The price list identifier.

currencyIdinteger(int32)

The currency identifier.

priceSalenumber(decimal)

The price sale.

timeStampstring(date-time)

The time stamp.

clientProductSku(ClientProductSku (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "partNo": "string",
    "applicationId": 0,
    "qtyBreak": 0,
    "clientId": 0,
    "priceListId": 0,
    "currencyId": 0,
    "priceSale": 0,
    "timeStamp": "2019-08-24T14:15:22Z",
    "clientProductSku": { … }
  }
]

Shopping

Operations

Metadata

Operations