Product Feed API (v1.0)

Download OpenAPI description
Languages
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

Status

Specifies the status for the part number.

string(Status)

Specifies the status for the part number.

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

Supplier

Represents a supplier record.

SupplierCodestring or null<= 50 characters

The unique code for the Supplier.

SupplierPartNostring or null<= 50 characters

The unique identifier for Supplier item.

SupplierPriceListCodestring or null<= 50 characters

Identifier of the supplier price list.

Currencystring or null

The currency code corresponding with ISO 4217, e.g. "GBP". For the supplier price list.

Costnumber(double)

The current reacquire cost (excluding VAT) if acquired from supplier. In the currency of the supplier.

OnHandValuenumber(double)

The current stock quantity.

IsStockCalculatedboolean

Defines if stock is calculated, meaning that OnHandValue is deferred and Supplier is to be considered to always have item in stock. Commonly set to false.

LeadTimeDayCountinteger or null(int32)

Estimated lead time until delivery can be made from this supplier.

ChosenSupplierOnPriceListsArray of strings or null

Lists all price list codes on which this supplier is marked as chosen (preselected) supplier.

AvailableOnPriceListsArray of strings or null

Lists all price list codes on which this supplier record is applicable.

{ "SupplierCode": "string", "SupplierPartNo": "string", "SupplierPriceListCode": "string", "Currency": "string", "Cost": 0.1, "OnHandValue": 0.1, "IsStockCalculated": true, "LeadTimeDayCount": 0, "ChosenSupplierOnPriceLists": [ "string" ], "AvailableOnPriceLists": [ "string" ] }

Variant

Represents a Variant.

PartNostring or null

Part number, the unique identifier of the Variant.

ManufacturerPartNostring or null

Manufacturer's part number.

NamesArray of objects(CultureNames)

Localized names for the Product.

EanCodestring or null

Primary EAN/GS1 code of the 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. If no prices are available, the product is inactivated and should be removed from target catalogs.

OnHandsArray of objects(OnHand)

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

SuppliersArray of objects(Supplier)

A collection of all suppliers listing the Variant.

FlagsArray of objects(Flag)

Active flags on the Variant level.

PrimaryImageobject or null

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

FilesArray of objects(File)

Additional images and files on the Variant level.

VariantDefiningParametricsArray of objects(Parametric)

Variant defining parametrics, meaning that these are configured to be used to define uniqueness of a variant in a Product scope. They are defined by the Variant type (called variant definition group in Norce Connect)

AdditionalParametricsArray of objects(Parametric)

Other Variant unique parametrics, not listed as variant defining, but can be different between variants.

RelationsArray of objects(Relation)

Relations on the Variant level.

TextsArray of objects(CultureTexts)

Localized text content for the Variant if "Product texts are variant unique" setting is enabled in Norce Commerce, otherwise omitted.

Logisticsobject or null

Logistic data (weight, height etc) for the Variant. Used for shipping calculations.

CommodityCodestring or null

Commodity code used for production identification in international commerce.

RecommendedQtynumber or null(double)

Recommended sales quantity for variant, suggesting the default quantity when adding the item to a cart.

IsRecommendedQtyFixedboolean

Specified if the Recommended sales quantity is locked in. If true, Norce will not allow other than multiples of RecommendedQty to be added to a cart. Note that use of this may affect user experience and external marketplaces outlook and ranking of the product.

StartDatestring or null(date-time)

Configured start date for item. If the product has Status "Coming", this date is when the product will become active. For an active product, this is the date from when the product was activated.

EndDatestring or null(date-time)

Configured end date for item. After this date, the item is automatically set to "Exiring" and will be inactivated by Norce Commerce, based on business rules.

Typestring or null

Product type. E.g. "Standard", "Service", "Freight" etc.

PopularitiesArray of objects(Popularity)

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

Idinteger(int32)

Norce internal product/variant id, same as "Id" in Norce Commerce Services.

TypeIdinteger(int32)

Product type id (for example: Standard=1, Freight=3, Service=11, Extended assortment=14, ManagedStructure=37, Virtual=40). See documentation for more.

ErpNameArray of objects(ErpNameCulture)

Erp Name, commonly mapped to product name in ERP system, commonly used by Norce Commerce in ERP integrations.

ProductCommentArray of objects(ProductCommentCulture)

Product internal Comments, localized if applicable.

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.

HistoricalBestPricesArray of objects(HistoricalBestPrice)

Historical prices from a specific time before the last price change.

HistoricalUniqueUrlsArray of objects(HistoricalUniqueUrls)

Historical unique url names

{ "PartNo": "string", "ManufacturerPartNo": "string", "Names": [ {} ], "EanCode": "string", "Status": "active", "Prices": [ {} ], "OnHands": [ {} ], "Suppliers": [ {} ], "Flags": [ {} ], "PrimaryImage": { "Type": "external", "Code": "string", "FileCode": "string", "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "MimeType": "string", "Url": "string", "SortOrder": 0, "Cultures": [] }, "Files": [ {} ], "VariantDefiningParametrics": [ {} ], "AdditionalParametrics": [ {} ], "Relations": [ {} ], "Texts": [ {} ], "Logistics": { "Width": 0.1, "Height": 0.1, "Depth": 0.1, "Weight": 0.1 }, "CommodityCode": "string", "RecommendedQty": 0.1, "IsRecommendedQtyFixed": true, "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Type": "string", "Popularities": [ {} ], "Id": 0, "TypeId": 0, "ErpName": [ {} ], "ProductComment": [ {} ], "DetailedPrices": [ {} ], "HistoricalBestPrices": [ {} ], "HistoricalUniqueUrls": [ {} ] }

Exports

Operations

Jobs

Operations