COMMERCE PRODUCT FEED

ProductCommentCulture

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

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": [
    { … }
  ]
}

ProductCommentCulture

Product comment in specific culture.

CultureCodestring or null

Represents language corresponding with ISO 639-1 (e.g. "en") alone or together with localization corresponding with ISO 3166-1 (e.g. "GB") Valid values can be both "en" or "en-GB". Most commonly used format is "xx-XX".

Commentstring or null<= 50 characters

The comment in localized text.

{
  "CultureCode": "string",
  "Comment": "string"
}

ProductStatus

Represents a ProductStatus (lightweight product message).

PartNostring or null

Part number, the unique identifier of the updated item (product or variant).

Statusstring(Status)

Specifies the status for the part number.

Enum"active""coming""expiring""hidden""inactive"

PricesArray of objects(Price)

The best price per Sales Area on the Application.

OnHandsArray of objects(OnHand)

A collection of all warehouses enabled and their stock values for the item.

SuppliersArray of objects(Supplier)

A collection of all suppliers listing the item.

PrimaryCategorystring or null

The primary category for the item.

ViewCountinteger(int32)

The view count for the item. A stat collected from Norce Commerce Services, by method UpdateProductViewCount and can be used for popularity ranking.

FlagsArray of objects(Flag)

Active flags on the item.

HistoricalBestPricesArray of objects(HistoricalBestPrice)

Historical prices the past 30 days before the last price change.

DetailedPricesArray of objects(Price)

Detailed prices for all requested pricelists (or all public pricelists if omitted). Prices selected is not constrained by application sales areas such as the prices field.

{
  "PartNo": "string",
  "Status": "active",
  "Prices": [
    { … }
  ],
  "OnHands": [
    { … }
  ],
  "Suppliers": [
    { … }
  ],
  "PrimaryCategory": "string",
  "ViewCount": 0,
  "Flags": [
    { … }
  ],
  "HistoricalBestPrices": [
    { … }
  ],
  "DetailedPrices": [
    { … }
  ]
}

Exports

Operations

Jobs

Operations