Norce Commerce Product v1.1 service (1.1)

The Product namespace has Entities and Operations used for Products and other related Entities such as Prices, Filters, Categories etc. The main use of the Product service is to retrieve product data, variants, prices, and its availability to be used in a webshop or other sales channels. The Product service is read only and does not support creating or updating data in Norce. For this, use the Connect API.

Download OpenAPI description
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Assortments

Contains endpoints for viewing metadata about assortment types, not commonly used anymore, still in use by legacy systems.

Operations

Categories

Contains endpoints for looking up category metadata.

Operations

Configurations

Contains endpoints for working with configuration products, not currently in use.

Operations

Families

Contains endpoints for viewing product family metadata, not commonly used anymore, but still needed in legacy systems.

Operations

Files

Contains endpoints for viewing file and image metadata.

Operations

Filters

Contains endpoints for working with ProductFilter navigations. Read more about it here.

Operations

Flags

Contains endpoints for viewing product flag metadata.

Operations

InfoTypes

Contains endpoints for viewing product related extended fields, info types.

Operations

Manufacturers

Contains endpoints for viewing manufacturer information.

Operations

OnHand

Contains endpoints for looking up detailed availability information.

Operations

Get product availability by part number

Request

Query
partNostring

Part number of the product to get.

statusSeedstring

(Optional) Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

(Optional) A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

(Optional) Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

(Optional) Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

(Optional) Specifies in which currency to display prices. Uses Norce internal ids. If none is supplied, value is resolved from Application.

Bodyapplication/json

(Optional) The actual list of warehouses to check OnHand for. OnHand in Warehouse is ignored.

Array [
StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

]
curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/GetProductOnHandByPartNo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "StoreId": 0,
      "WarehouseId": 0,
      "LocationId": 0,
      "OnHand": {
        "Value": 0,
        "IncomingValue": 0,
        "NextDeliveryDate": "2019-08-24T14:15:22Z",
        "LeadtimeDayCount": 0,
        "LastChecked": "2019-08-24T14:15:22Z",
        "IsActive": true,
        "IsReturnable": true,
        "Info": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ]
      }
    }
  ]'

Responses

OK

Bodyapplication/json
ProductIdinteger or null(int32)

The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

WarehousesArray of objects or null(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects or null(ProductOnHand)

An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.

Response
application/json
{ "ProductId": 0, "Warehouses": [ { … } ], "Variants": [ {} ] }

Get product availability by id

Request

Query
productIdinteger(int32)

Internal id of the product to get.

statusSeedstring

(Optional) Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

(Optional) A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

(Optional) Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

(Optional) Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

(Optional) Specifies in which currency to display prices. Uses Norce internal ids. If none is supplied, value is resolved from Application.

Bodyapplication/json

(Optional) The actual list of warehouses to check OnHand for. OnHand in Warehouse is ignored.

Array [
StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

]
curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/GetProductOnHandByProduct \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "StoreId": 0,
      "WarehouseId": 0,
      "LocationId": 0,
      "OnHand": {
        "Value": 0,
        "IncomingValue": 0,
        "NextDeliveryDate": "2019-08-24T14:15:22Z",
        "LeadtimeDayCount": 0,
        "LastChecked": "2019-08-24T14:15:22Z",
        "IsActive": true,
        "IsReturnable": true,
        "Info": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ]
      }
    }
  ]'

Responses

OK

Bodyapplication/json
ProductIdinteger or null(int32)

The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

WarehousesArray of objects or null(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects or null(ProductOnHand)

An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.

Response
application/json
{ "ProductId": 0, "Warehouses": [ { … } ], "Variants": [ {} ] }

Parametric

Contains endpoints for viewing parametric meta data and parametric data used in comparison views.

Operations

PriceLists

Contains endpoints for viewing price list data and metadata.

Operations

Products

Contains endpoints for listing, finding and viewing products, variants and its content. Read more about this here and here

Operations

Promotions

Contains endpoints for listing products based on promotion associations.

Operations

Relations

Contains endpoints for listing products based on their relations and relation metadata.

Operations

Reviews

Contains endpoints for managing product reviews, not commonly used anymore, still in use by legacy systems.

Operations

SkuTypes

Contains endpoints for looking up product type metadata.

Operations

Status

Contains endpoints for looking up product status metadata.

Operations

Variants

Contains endpoints for listing variants.

Operations

Warehouses

Contains endpoints for viewing warehouse and location information.

Operations

Schemas