SCHEMA REFERENCES
/
Commerce Product Feed
Last updated

Channel export schemas

Set up exports of product catalogs to different channels.

Main schemas

Product

partNostring or null
statusstring(Status)

Specifies the status for the part number.

Enum"Active""Coming""Expiring""Hidden""Inactive"
pricesArray of objects or null or null(Price)
onHandsArray of objects or null or null(OnHand)
suppliersArray of objects or null or null(Supplier)
primaryCategorystring or null
viewCountinteger(int32)
flagsArray of objects or null or null(Flag)

ProductStatus

partNostring or null
statusstring(Status)

Specifies the status for the part number.

Enum"Active""Coming""Expiring""Hidden""Inactive"
pricesArray of objects or null or null(Price)
onHandsArray of objects or null or null(OnHand)
suppliersArray of objects or null or null(Supplier)
primaryCategorystring or null
viewCountinteger(int32)
flagsArray of objects or null or null(Flag)

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*object or nulladditional property
object or null

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
namestring or null
idinteger(int32)

Internal id of the value

CultureNames

cultureCodestring or null
namestring or null
uniqueUrlNamestring or null

CategoryCulture

cultureCodestring or null
namestring or null
fullNamestring or null
synonymsstring or null

Category

codestring or null
culturesArray of objects or null or null(CategoryCulture)
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
locationCodestring or null
idinteger(int32)

Norce internal warehouse id

locationIdinteger(int32)

Norce internal location id

Price

salesAreastring or null
priceListCodestring or null
currencystring or null
valuenumber(double)
isDiscountableboolean
originalnumber or null(double)
vatRatenumber(double)
availableOnWarehousesArray of objects or null or null(Warehouse)
purchaseCostnumber(double)
unitCostnumber(double)
isActiveboolean
valueIncVatnumber(double)

The chosen price, incl VAT

priceListIdinteger(int32)

Norce internal Price list Id

recommendedPricenumber or null(double)

Recommended price, if exists.

standardPricenumber or null(double)

Standard price, if exists.

catalogPricenumber or null(double)

Catalog price, if exists.

recommendedPriceIncVatnumber or null(double)

Recommended price, incl VAT, if exists.

standardPriceIncVatnumber or null(double)

Standard price, incl VAT, if exists.

catalogPriceIncVatnumber or null(double)

Catalog price, incl VAT, if exists.

availableQuantityBreaksArray of objects or null or null(QuantityBreakPrice)

Available quantity breaks

WarehouseType

string

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

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

OnHand

warehouseobject or null(Warehouse)

Represents a Warehouse, on which stock information is kept.

warehouseTypestring(WarehouseType)

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

Enum"Warehouse""Store""Transit""Other"
valuenumber(double)
leadTimeDayCountinteger or null(int32)
availableOnStoresArray of strings or null
availableOnPriceListsArray of strings or null
nextDeliverystring or null(date-time)

Supplier

supplierCodestring or null
supplierPartNostring or null
supplierPriceListCodestring or null
currencystring or null
costnumber(double)
onHandValuenumber(double)
isStockCalculatedboolean
leadTimeDayCountinteger or null(int32)
chosenSupplierOnPriceListsArray of strings or null
availableOnPriceListsArray of strings or null

FlagCulture

cultureCodestring or null
namestring or null
groupNamestring or null

Flag

codestring or null
culturesArray of objects or null or null(FlagCulture)
idinteger(int32)

Norce internal flag id

groupCodestring or null

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
fileCodestring or null
keystring or null(uuid)
mimeTypestring or null
urlstring or null
sortOrderinteger or null(int32)

The sort order within the type of files

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
namestring or null
groupNamestring or null
unitOfMeasurementstring or null
valueobject or null
object or null
listValueobject or null(CodeName)

Generic Code/Name entity, without localization.

multipleValuesArray of objects or null or null(CodeName)

Parametric

codestring or null
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)
culturesArray of objects or null or null(ParametricCulture)
idinteger(int32)

Internal parametric id

groupCodestring or null

Relation

typestring or null
partNostring or null
codestring or null

Identifier for the relation type.

CultureTexts

cultureCodestring or null
descriptionHeaderstring or null
descriptionstring or null
subHeaderstring or null
subDescriptionstring or null
synonymsstring or null

Logistics

widthnumber or null(double)
heightnumber or null(double)
depthnumber or null(double)
weightnumber or null(double)

Variant

partNostring or null
manufacturerPartNostring or null
namesArray of objects or null or null(CultureNames)
eanCodestring or null
statusstring(Status)

Specifies the status for the part number.

Enum"Active""Coming""Expiring""Hidden""Inactive"
pricesArray of objects or null or null(Price)
onHandsArray of objects or null or null(OnHand)
suppliersArray of objects or null or null(Supplier)
flagsArray of objects or null or null(Flag)
primaryImageobject or null(File)

Represents a File, a reference to an asset in Norce [Storm] or external reference (e.g. Youtube url)

filesArray of objects or null or null(File)
variantDefiningParametricsArray of objects or null or null(Parametric)
additionalParametricsArray of objects or null or null(Parametric)
relationsArray of objects or null or null(Relation)
textsArray of objects or null or null(CultureTexts)
logisticsobject or null(Logistics)

Contains logistic data for an item.

commodityCodestring or null
recommendedQtynumber or null(double)
isRecommendedQtyFixedboolean
startDatestring or null(date-time)
endDatestring or null(date-time)
typestring or null

Product type.

popularitiesArray of objects or null or null(Popularity)

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

idinteger(int32)

Norce internal variant id, same as "Id" in Norce [Storm] API.

typeIdinteger(int32)

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

FamilyCulture

cultureCodestring or null
namestring or null

Family

codestring or null
culturesArray of objects or null or null(FamilyCulture)

Popularity

sourcestring or null
categoryRankinteger(int32)
categoryRankMaxinteger(int32)
totalRankinteger(int32)
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.

Previous page
Next page