Last updated

Channel export schemas

Set up exports of product catalogs to different channels.

Main schemas

Product

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.

ProductStatus

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.

Supporting schemas

JobRunRequest

channelKeystring(uuid)
deltaFromDatestring or null(date-time)
channelIdstring(uuid)Deprecated
endpointUrlstring or nullDeprecated

ResponseCode

string
Enum"Success""AlreadyInProgress""NoData""Failed"

ExportFeedResponse

codestring(ResponseCode)
Enum"Success""AlreadyInProgress""NoData""Failed"
jobKeystring or null
dataUrlstring or null
contentTypestring or null
itemsTotalinteger(int32)

ProblemDetails

typestring or null
titlestring or null
statusinteger or null(int32)
detailstring or null
instancestring or null
property name*anyadditional property

JobStatus

string
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"

GetJobResponse

clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)

CodeName

Codestring or null<= 50 characters

The unique identifier or the value in context.

Namestring or null

The descriptive name of the value.

Idinteger(int32)

Internal id of the value in Norce.

CultureNames

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".

Namestring or null<= 255 characters

The product of variant name on the specific culture.

UniqueUrlNamestring or null<= 500 characters

Manually set or generated unique URL name. The field is called "Unique url" in admin and "UniqueName" in Norce Commerce Services.

CategoryCulture

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".

Namestring or null<= 50 characters

The name of the Category.

FullNamestring or null<= 500 characters

All category names in the hierarchy with " - " between, example: "Furniture - Table".

Synonymsstring or null<= 500 characters

Configured synonyms for the Category. MaxLength: 500

Category

Codestring or null<= 50 characters

The unique identifier of the Category.

CulturesArray of objects(CategoryCulture)

The localized names and synonyms of the Category per culture code.

Idinteger(int32)

Norce internal category id

Status

string

Specifies the status for the part number.

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

Warehouse

Codestring or null<= 50 characters

Unique code of warehouse.

LocationCodestring or null<= 50 characters

Unique code of warehouse location.

Idinteger(int32)

Norce internal warehouse id

LocationIdinteger(int32)

Norce internal location id

Price

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.

WarehouseType

string

Specifies the warehouse type, used to differentiate between normal warehouses, stores, transit warehouses etc, which is used differently in Norce Commerce business logic.

Enum"warehouse""store""transit""other"

OnHand

Warehouseobject or null

The unique warehouse reference.

WarehouseTypestring(WarehouseType)

Specifies the warehouse type, used to differentiate between normal warehouses, stores, transit warehouses etc, which is used differently in Norce Commerce business logic.

Enum"warehouse""store""transit""other"
Valuenumber(double)

The current stock quantity, excluding reserved stock.

LeadTimeDayCountinteger or null(int32)

Lead time until delivery can be made. Named as a "Day count" but can be any unit of time defined by the client.

AvailableOnStoresArray of strings

Lists all stores on which this product is available. A list of store codes (not store warehouses).

AvailableOnPriceListsArray of strings or null

Lists all price lists on which this product has a price. A list of price list codes.

NextDeliverystring or null(date-time)

The next delivery date from supplier to this warehouse. Called "NextDeliveryDate" in Norce Commerce Services.

IncomingValuenumber or null(double)

The incoming inventory value for this warehouse.

Supplier

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.

FlagCulture

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".

Namestring or null<= 50 characters

The name of the Flag.

GroupNamestring or null<= 50 characters

The name of its flag group.

Flag

Codestring or null<= 50 characters

The unique identifier of the Flag.

CulturesArray of objects(FlagCulture)

The localized names of the Flag.

Idinteger(int32)

Norce internal flag id

GroupCodestring or null<= 50 characters

The unique identifier of the Flag Group.

FileType

string

Specifies the type of a specific File.

Enum"external""asset"

File

Typestring(FileType)

Specifies the type of a specific File.

Enum"external""asset"
Codestring or null<= 255 characters

The unique identifier of this specific instance of a file. Called "ExternalCode" in Connect. This can be null, but common practice is to have a unique code for each file. Used for removing or updating from api´s. The Code can be set by the user or from Norce, in admin, when uploading a new asset, usually based on the oridiginal file name or url.

FileCodestring or null<= 50 characters

The unique identifier for the file type. e.g. "PrimaryImage", "Additional image", "Winter images", "Data sheets". For primary images the code is always set to "PrimaryImage".

Keystring or null(uuid)

The reference to the File if Type is Asset.

MimeTypestring or null

The MimeType of the File, omitted if Type is External. For example: "image/jpeg" or "application/pdf"

Urlstring or null

The url reference to the File. Having the "Key" as part of the Url path.

SortOrderinteger or null(int32)

The sort order within the type of files, if any.

CulturesArray of objects or null(FileCulture)

The localized meta data for each culture.

ParametricType

string

Specifies the parametric type, used to interpret the value set on a Parametric.

Enum"text""integer""decimal""boolean""html""date""list""multiple"

ParametricCulture

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".

Namestring or null<= 50 characters

The name of the Parametric.

GroupNamestring or null<= 50 characters

The group name of the Parametric, as defined on the primary category.

UnitOfMeasurementstring or null<= 50 characters

Configured unit of measurement for the Parametric.

Valueobject or null

Value set on the Parametric. Can be of type "Text", "Integer", "Decimal", "Boolean", "Html" or "Date". For list and multiple types the value is null.

ListValueobject or null

Detailed code/name information if Type is "ListValue".

MultipleValuesArray of objects or null(CodeName)

Detailed code/name information if Type is "MultipleValue".

Parametric

Codestring or null<= 50 characters

The unique identifier of the Parametric.

Typestring(ParametricType)

Specifies the parametric type, used to interpret the value set on a Parametric.

Enum"text""integer""decimal""boolean""html""date""list""multiple"
SortOrderinteger or null(int32)

The sort order of the parametric, based on primary category settings.

CulturesArray of objects(ParametricCulture)

The descriptive names of the Parametric along with the actual value set per culture code.

Idinteger(int32)

Internal parametric id

GroupCodestring or null<= 50 characters

The unique identifier of the Parametric Group.

Relation

Typestring or null<= 50 characters

The un-localized default name of the Relation type. Retained for backwards compatibility with consumers that have not yet adopted ; use for localized names.

PartNostring or null

Part number reference of related variant (or product). For a variant, if entire product is related, all part numbers are specified in the list.

Codestring or null<= 50 characters

Identifier for the relation type.

CulturesArray of objects(RelationCulture)

The localized names of the Relation type.

CultureTexts

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".

DescriptionHeaderstring or null<= 255 characters

An header for the description.

Descriptionstring or null

The Description of the Product, can contain HTML tags. No limit in string length defined in Norce.

SubHeaderstring or null<= 255 characters

The header for the sub description.

SubDescriptionstring or null

The sub description of the Product, can contain HTML tags. No limit in string length defined in Norce.

Synonymsstring or null<= 500 characters

Configured synonyms for the Product.

MetaTagsstring or null

SEO meta tags for the Product.

MetaDescriptionstring or null

SEO meta description for the Product.

Logistics

Widthnumber or null(double)

The width of the item in predefined unit (commonly cm). The unit can be changed in client setting.

Heightnumber or null(double)

The height of the item in predefined unit (commonly cm). The unit can be changed in client setting.

Depthnumber or null(double)

The depth of the item in predefined unit (commonly cm). The unit can be changed in client setting.

Weightnumber or null(double)

The weight of the item in predefined unit (commonly kg). The unit can be changed in client setting.

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

FamilyCulture

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".

Namestring or null<= 50 characters

The name of the Family.

Family

Codestring or null<= 50 characters

The unique identifier of the Family.

CulturesArray of objects(FamilyCulture)

The localized names of the Family.

Popularity

Sourcestring or null

The popularity source, can be calculated from Norce Commerce: "Internal", "External" sources are deprecated.

CategoryRankinteger(int32)

The popularity rank (lower is more popular) in current category, based on Primary Category.

CategoryRankMaxinteger(int32)

The max rank in current category, based on Primary Category.

TotalRankinteger(int32)

The total ranking, across all products.

ApplicationIdinteger or null(int32)

Application reference. If client setting is "Product popularity by application" = true the rank will be restricted to this application only. If false, applicationid can be ignored.