COMMERCE PRODUCT FEED

ProblemDetails

Product Feed API (v1.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

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

Stage

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

Production

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

Schemas

Price

Represents the chosen Price for a specific Variant, unique by SalesArea.

SalesAreastring or null<= 50 characters

The sales area of the chosen price list,

PriceListCodestring or null<= 50 characters

The price list code. Called "Agreement" in Norce Commerce Services and Query.

Currencystring or null<= 3 characters

The currency code corresponding with ISO 4217, e.g. "GBP", "SEK".

Valuenumber(double)

The current best sale price, excluding VAT, with 2 decimal precision.

IsDiscountableboolean

Defines if the current price is further discountable (or not) by promotions.

Originalnumber or null(double)

The original price, excl VAT. Can be used as "strike-through" price and can be omitted, if the price list hasn't got one. (Note, this is either Recommended price or Standard price depending on what exists, both also provided separately)

VatRatenumber(double)

The VAT rate as a multiplication factor. 25 % VAT corresponds to a value of 1.25

AvailableOnWarehousesArray of objects(Warehouse)

The warehouses on which this product has this price.

PurchaseCostnumber(double)

The current reacquire cost for the product in this price list.

UnitCostnumber(double)

The current stock based cost for the product.

IsActiveboolean

Defines if the price is active (buy-able) or not.

ValueIncVatnumber(double)

The current best sale price, including VAT, with 2 decimal precision.

PriceListIdinteger(int32)

Norce internal Price list Id

RecommendedPricenumber or null(double)

Recommended price, if exists excluding VAT.

StandardPricenumber or null(double)

Standard price, if exists excluding VAT.

CatalogPricenumber or null(double)

Catalog price, if exists excluding VAT.

RecommendedPriceIncVatnumber or null(double)

Recommended price, including VAT, if exists.

StandardPriceIncVatnumber or null(double)

Standard price, including VAT, if exists.

CatalogPriceIncVatnumber or null(double)

Catalog price, including VAT, if exists.

AvailableQuantityBreaksArray of objects or null(QuantityBreakPrice)

Available quantity breaks for the price list.

PreviousPricenumber or null(double)

Previous price, excluding VAT, if exists. Can be used to provide the current historical best price, if the functionality is enabled.

Priorityinteger or null(int32)

The priority of the price list type (from PriceListType). Lower values indicate higher priority. Null means no priority is set.

{
  "SalesArea": "string",
  "PriceListCode": "string",
  "Currency": "str",
  "Value": 0.1,
  "IsDiscountable": true,
  "Original": 0.1,
  "VatRate": 0.1,
  "AvailableOnWarehouses": [
    { … }
  ],
  "PurchaseCost": 0.1,
  "UnitCost": 0.1,
  "IsActive": true,
  "ValueIncVat": 0.1,
  "PriceListId": 0,
  "RecommendedPrice": 0.1,
  "StandardPrice": 0.1,
  "CatalogPrice": 0.1,
  "RecommendedPriceIncVat": 0.1,
  "StandardPriceIncVat": 0.1,
  "CatalogPriceIncVat": 0.1,
  "AvailableQuantityBreaks": [
    { … }
  ],
  "PreviousPrice": 0.1,
  "Priority": 0
}

ProblemDetails

typestring or null

titlestring or null

statusinteger or null(int32)

detailstring or null

instancestring or null

property name*anyadditional property

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Product

A product can contain one or more variants, where variant contains the individual sku.

Codestring or null<= 50 characters

Unique Reference for Product, might be omitted if product only contains one variant. Same as "Code" in Norce Commerce Connect ImportProducts.

Manufacturerobject or null

Represent the Manufacturer of the Product.

NamesArray of objects(CultureNames)

Localized names for the Product.

PrimaryCategoryobject or null

The Primary Category of the Product.

AdditionalCategoriesArray of objects(Category)

Additional Categories set on the product, if any.

VariantsArray of objects(Variant)

A Product must have at least one Variant, if multiple variants exists, Product.Code is required.

FamiliesArray of objects(Family)

Active families set on the Product.

FlagsArray of objects(Flag)

Active flags on the Product level. Note that disabled flags are not included.

PrimaryImageobject or null

Primary image reference for the Product, is always of Type Asset (See File type).

FilesArray of objects(File)

Images and files on the Product level.

ParametricsArray of objects(Parametric)

Parametrics on the Product level, shared by all variants.

RelationsArray of objects(Relation)

Relations on the Product level, shared by all variants.

TextsArray of objects(CultureTexts)

Localized text content for the Product, shared by all variants.

PopularitiesArray of objects(Popularity)

Popularities on the Product level (depending on the client setting "Product popularity by variant" = false).

GroupByIdinteger or null(int32)

Internal variant grouping id. Same as "GroupByKey" in Norce Commerce API, but as an Int. Att a "v" as prefix to match it with the key. Null for products without variants (where code is null and number of variants = 1).

HistoricalUniqueUrlsArray of objects(HistoricalUniqueUrls)

Historical Unique Urls, lists older values for the unique url on the product level, note that this value is no longer forced to be unique by Norce.

{
  "Code": "string",
  "Manufacturer": {
    "Code": "string",
    "Name": "string",
    "Id": 0
  },
  "Names": [
    { … }
  ],
  "PrimaryCategory": {
    "Code": "string",
    "Cultures": [ … ],
    "Id": 0
  },
  "AdditionalCategories": [
    { … }
  ],
  "Variants": [
    { … }
  ],
  "Families": [
    { … }
  ],
  "Flags": [
    { … }
  ],
  "PrimaryImage": {
    "Type": "external",
    "Code": "string",
    "FileCode": "string",
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "MimeType": "string",
    "Url": "string",
    "SortOrder": 0,
    "Cultures": [ … ]
  },
  "Files": [
    { … }
  ],
  "Parametrics": [
    { … }
  ],
  "Relations": [
    { … }
  ],
  "Texts": [
    { … }
  ],
  "Popularities": [
    { … }
  ],
  "GroupById": 0,
  "HistoricalUniqueUrls": [
    { … }
  ]
}

Exports

Operations

Jobs

Operations