Channel export schemas

Set up exports of product catalogs to different channels.

Main schemas

Product

code	string or null
	object or null (CodeName) Generic Code/Name entity, without localization.
	Array of objects or null or null (CultureNames)
	object or null (Category) Represents a Category with localized names.
	Array of objects or null or null (Category)
	Array of objects or null or null (Variant)
	Array of objects or null or null (Family)
	Array of objects or null or null (Flag)
	object or null (File) Represents a File, a reference to an asset in Norce [Storm] or external reference (e.g. Youtube url)
	Array of objects or null or null (File)
	Array of objects or null or null (Parametric)
	Array of objects or null or null (Relation)
	Array of objects or null or null (CultureTexts)
	Array of objects or null or null (Popularity)
groupById	integer or null <int32> Internal variant grouping id. Same as "GroupByKey" in Norce [Storm] API, but as an Int. Att a "v" as prefix to match it with the key.

ProductStatus

partNo	string or null
status	string (Status) Specifies the status for the part number. Enum: "Active" "Coming" "Expiring" "Hidden" "Inactive"
	Array of objects or null or null (Price)
	Array of objects or null or null (OnHand)
	Array of objects or null or null (Supplier)
primaryCategory	string or null
viewCount	integer <int32>
	Array of objects or null or null (Flag)

Supporting schemas

JobRunRequest

channelKey	string <uuid>
deltaFromDate	string or null <date-time>
channelId	string <uuid> Deprecated
endpointUrl	string or null Deprecated

ResponseCode

string (ResponseCode)

Enum: "Success" "AlreadyInProgress" "NoData" "Failed"

ExportFeedResponse

code	string (ResponseCode) Enum: "Success" "AlreadyInProgress" "NoData" "Failed"
jobKey	string or null
dataUrl	string or null
contentType	string or null
itemsTotal	integer <int32>

ProblemDetails

type	string or null
title	string or null
status	integer or null <int32>
detail	string or null
instance	string or null
additional property	object or null

JobStatus

string (JobStatus)

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

GetJobResponse

clientId	integer <int32>
key	string <uuid>
channelKey	string <uuid>
endpoint	string or null
type	string or null
deltaFromDate	string or null <date-time>
itemsTotal	integer <int32>
statusId	string (JobStatus) Enum: "Unknown" "Initialized" "WaitingForSlot" "RunningInExportFeed" "CompletedInExportFeed" "CompletedByAdapter" "NoContent" "Failed" "Cancelled"
start	string <date-time>
stop	string or null <date-time>
lastUpdated	string <date-time>

CodeName

code	string or null
name	string or null
id	integer <int32> Internal id of the value

CultureNames

cultureCode	string or null
name	string or null
uniqueUrlName	string or null

CategoryCulture

cultureCode	string or null
name	string or null
fullName	string or null
synonyms	string or null

Status

string (Status)

Specifies the status for the part number.

Enum: "Active" "Coming" "Expiring" "Hidden" "Inactive"

Warehouse

code	string or null
locationCode	string or null
id	integer <int32> Norce internal warehouse id
locationId	integer <int32> Norce internal location id

Price

salesArea	string or null
priceListCode	string or null
currency	string or null
value	number <double>
isDiscountable	boolean
original	number or null <double>
vatRate	number <double>
	Array of objects or null or null (Warehouse)
purchaseCost	number <double>
unitCost	number <double>
isActive	boolean
valueIncVat	number <double> The chosen price, incl VAT
priceListId	integer <int32> Norce internal Price list Id
recommendedPrice	number or null <double> Recommended price, if exists.
standardPrice	number or null <double> Standard price, if exists.
catalogPrice	number or null <double> Catalog price, if exists.
recommendedPriceIncVat	number or null <double> Recommended price, incl VAT, if exists.
standardPriceIncVat	number or null <double> Standard price, incl VAT, if exists.
catalogPriceIncVat	number or null <double> Catalog price, incl VAT, if exists.
	Array of objects or null or null (QuantityBreakPrice) Available quantity breaks

WarehouseType

string (WarehouseType)

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

Enum: "Warehouse" "Store" "Transit" "Other"

OnHand

	object or null (Warehouse) Represents a Warehouse, on which stock information is kept.
warehouseType	string (WarehouseType) Specifies the parametric type, used to interpret the value set on a Parametric. Enum: "Warehouse" "Store" "Transit" "Other"
value	number <double>
leadTimeDayCount	integer or null <int32>
availableOnStores	Array of strings or null
availableOnPriceLists	Array of strings or null
nextDelivery	string or null <date-time>

Supplier

supplierCode	string or null
supplierPartNo	string or null
supplierPriceListCode	string or null
currency	string or null
cost	number <double>
onHandValue	number <double>
isStockCalculated	boolean
leadTimeDayCount	integer or null <int32>
chosenSupplierOnPriceLists	Array of strings or null
availableOnPriceLists	Array of strings or null

FlagCulture

cultureCode	string or null
name	string or null
groupName	string or null

Flag

code	string or null
	Array of objects or null or null (FlagCulture)
id	integer <int32> Norce internal flag id
groupCode	string or null

FileType

string (FileType)

Specifies the type of a specific File.

Enum: "External" "Asset"

File

type	string (FileType) Specifies the type of a specific File. Enum: "External" "Asset"
code	string or null
fileCode	string or null
key	string or null <uuid>
mimeType	string or null
url	string or null
sortOrder	integer or null <int32> The sort order within the type of files

ParametricType

string (ParametricType)

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

Enum: "Text" "Integer" "Decimal" "Boolean" "Html" "Date" "List" "Multiple"

ParametricCulture

cultureCode	string or null
name	string or null
groupName	string or null
unitOfMeasurement	string or null
	object or null
	object or null (CodeName) Generic Code/Name entity, without localization.
	Array of objects or null or null (CodeName)

Parametric

code	string or null
type	string (ParametricType) Specifies the parametric type, used to interpret the value set on a Parametric. Enum: "Text" "Integer" "Decimal" "Boolean" "Html" "Date" "List" "Multiple"
sortOrder	integer or null <int32>
	Array of objects or null or null (ParametricCulture)
id	integer <int32> Internal parametric id
groupCode	string or null

Relation

type	string or null
partNo	string or null
code	string or null Identifier for the relation type.

CultureTexts

cultureCode	string or null
descriptionHeader	string or null
description	string or null
subHeader	string or null
subDescription	string or null
synonyms	string or null

Logistics

width	number or null <double>
height	number or null <double>
depth	number or null <double>
weight	number or null <double>

Variant

partNo	string or null
manufacturerPartNo	string or null
	Array of objects or null or null (CultureNames)
eanCode	string or null
status	string (Status) Specifies the status for the part number. Enum: "Active" "Coming" "Expiring" "Hidden" "Inactive"
	Array of objects or null or null (Price)
	Array of objects or null or null (OnHand)
	Array of objects or null or null (Supplier)
	Array of objects or null or null (Flag)
	object or null (File) Represents a File, a reference to an asset in Norce [Storm] or external reference (e.g. Youtube url)
	Array of objects or null or null (File)
	Array of objects or null or null (Parametric)
	Array of objects or null or null (Parametric)
	Array of objects or null or null (Relation)
	Array of objects or null or null (CultureTexts)
	object or null (Logistics) Contains logistic data for an item.
commodityCode	string or null
recommendedQty	number or null <double>
isRecommendedQtyFixed	boolean
startDate	string or null <date-time>
endDate	string or null <date-time>
type	string or null Product type.
	Array of objects or null or null (Popularity) Popularities on the Variant level (depending on the client setting "Product popularity by variant" = true).
id	integer <int32> Norce internal variant id, same as "Id" in Norce [Storm] API.
typeId	integer <int32> Product type id (for example: Standard=1, Freight=3, Service=11, Extended assortment=14, ManagedStructure=37, Virtual=40). See documentation for more.

FamilyCulture

cultureCode	string or null
name	string or null

Family

code	string or null
	Array of objects or null or null (FamilyCulture)

Popularity

source	string or null
categoryRank	integer <int32>
categoryRankMax	integer <int32>
totalRank	integer <int32>
applicationId	integer 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.