Connect Product schemas
Entities, enums and methods for importing products and product related information.
Entities
CompetitorSku
CompetitorCode required | string Unique code for competitor. |
CompetitorPartNo required | string Competitor part number. |
IsInStock required | boolean Specifies if the SKU is in stock at the competitor. |
IsPricesInclVat required | boolean Specifies if prices are incl. VAT (true) or excluding VAT (false). |
PartNo required | string Part number in Norce to which the competitor data is referencing. |
PriceSale required | number The sale price from the competitor. |
PriceSaleInclFreight required | number Competitor sale price incl. freight, same as PriceSale if no freight. |
Source required | string Source of competitor data. |
CompetitorName | string Name of the competitor. |
CurrencyCode | string ISO 4217 code for the currency that prices are in. |
object <ExternalPopularity> (ExternalPopularity) Represents a popularity ranking from an external source. | |
ProductName | string Product name for competitor data. |
SalesArea | string Specifies target sales area. |
VatRate | number VAT rate in percentage. |
CompetitorSkuHeader
AccountId required | integer <int32> Account which initiated the import. Learn about system accounts here. |
CompetitorSkuFieldsThatAreSet required | Array of strings Array of strings representing competitor fields to be processed. |
FullFile required | boolean Flag that specify how Norce Commerce Connect will handle the import. If true, all prices from the competitors not in this import will be deactivated. If false, the import will be handled as an update only, and other products already having prices will be ignored. |
JobId | string Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request. |
SerializationType | Array of strings Request serialization type.(Use the integer instead of the name for the xml content type) |
StorageName | string <uri> Location of the import file on Norce's file area. Can be used instead of sending data directly in payload. |
SupplierId | integer <int32> Derived from base header. Ignored in competitor import. |
DeliveryMethod
Code required | string Delivery method code. Used for delivery method matching in Norce Commerce. |
IsActive | boolean Sets product delivery method to active or inactive. Default true. |
PackagePercentage | number Package percentage. |
ExternalPopularity
PartNo required | string Part number in Norce Commerce to which the popularity information is referencing. |
PopularityValue | number The popularity valu for the SKU. |
Source | string The name of the external source. This name must correlate to a configured source in Norce Commerce. |
Flag
Code required | string Product flag code. Used for product flag matching in Norce Commerce. |
IsSet required | boolean Determines if a product flag is to be set or unset. |
IsCreateOnly | boolean If true, data is only saved if flag record is new. Default: false. |
IsLimitedUpdate | boolean If true, data is only saved if flag record is new or last updated by the same account as the one initiating the update. Default: false |
StopDate | string <DateTime> Shows when flag was disabled for product. |
Image
ExternalCode required | string External identifier for image matching. |
FileTypeName required | string File type code. Should match file info set up in Norce Commerce, e.g. "MainImage", "Additional", "Embedded". |
Url required | string <uri> Url to where the image is located. Must be a publically accessible endpoint. |
FileName | string Image file name. If omitted it will be parsed from the url. Max length: 50 |
LastModified | string <DateTime> Time when image was last updated. Deprecated. |
Info
Code required | string External code for additional information field to be matched in Norce Commerce. |
Value required | string Value to be set or updated on the information field. |
ParametricValue
ParametricCode required | string External parametric code configured in Norce Commerce. Used to match parameter. |
Array of objects <ParametricValueCulture> (ParametricValueCulture) List of parametric translations. | |
Array of objects <ParametricValueList> (ParametricValueList) List of possible values to set for parametrics with multiple value choice. | |
ValueBoolean | boolean Boolean value to set. |
ValueDateTime | string <DateTime> Date/time value to set. |
ValueDecimal | number Decimal value to set. |
ValueInteger | integer Integer value to set. |
object <ParametricValueList> (ParametricValueList) Parametric value for list of choices. |
ParametricValueCulture
CultureCode required | string Culture code, e.g. "sv-SE". |
ValueText required | string Translated text parametric value. Max length 255 chars for text-values, unlimited for HTML-values. |
ParametricValueList
Code required | string Parametric value code. Use for parametric value matching in Norce Commerce. |
Value required | string Value to set |
Description | string Description of the value |
Array of objects <ParametricValueListCulture> (ParametricValueListCulture) Array with localized versions of value and description |
PriceList
Code required | string Externally defined price list code. Used to match price list in Norce Commerce. |
CurrencyCode | string Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". |
DefaultPriceRule | integer <int32> Price rule to be set as default. |
DefaultPriceRuleCode | string Deprecated |
DefaultPriceRuleValue | number Default price list value. |
Description | string Price list description |
EndDate | string <DateTime> End date/time when price list is no longer valid. |
IsErpIntegrated | boolean Deprecated |
IsPrimary | boolean Determines if price list is primary. Only one price list can be primary on an application. |
IsPublic | boolean Determines if price list is public and active. |
IsFavorite | boolean Determines if price list is favorite for the current application. |
Name | string Price list name. Max length: 50 |
StartDate | string <DateTime> Start time when price list is valid and applied. |
TypeCode | string Price list type code |
Array of objects <Warehouse> (Warehouse) List of warehouses where this price list is applicable. | |
SalesArea | integer <int32> Sales area identifier. |
DefaultMinMarginPercent | number Default minimum product margin percentage. |
LimitToRecPrice | boolean Limit to recommended price. |
ParentPriceListCode | string Code of parent price list. |
DefaultSupplementalChargeFixed | number Default supplemental charge (fixed) |
DefaultSupplementalChargePercent | number Default supplemental charge (percentage) |
Array of objects <PriceListPriceRule> (PriceListPriceRule) List of price rules. | |
object <PriceListPopulation> (PriceListPopulation) Price list population. |
PriceListHeader
AccountId required | integer <int32> Account which initiated the import. Learn about system accounts here. |
PriceListFieldsThatAreSet required | Array of strings Array of strings representing price list fields to be processed. |
JobId | string Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request.. |
SerializationType | Array of strings Request serialization type.(Use the integer instead of the name for the xml content type) |
StorageName | string <uri> Location of the import file on Norce's file area. Can be used instead of sending data directly in payload. |
SupplierId | integer <int32> Derived from base header. Ignored in price list import. |
WarehouseFieldsThatAreSet | Array of strings Array of strings representing warehouse fields to be processed. |
WarehouseLocationFieldsThatAreSet | Array of strings Array of strings representing warehouse location fields to be processed. |
PriceListPriceRuleFieldsThatAreSet | Array of strings Array of strings representing price list rule fields to be processed. |
Product
Code | string Product code. Used for product cluster matching in Norce Commerce. |
ManufacturerCode | string Manufacturer code. |
Array of objects <Image> (Image) List of additional product images. | |
Alias | string Product alias. |
AssortmentCode | string Product assortment code. If set, assortment with this code will be associated to product. |
Array of objects <ProductCategory> (ProductCategory) List of categories product shall be placed in. | |
Array of objects <ProductCulture> (ProductCulture) List of translated product information fields. | |
object <ProductFamily> (ProductFamily) Product family information. Families that can not be matched will not be created but give a warning in the logs. | |
object <Image> (Image) Product image information. | |
ManufacturerName | string Manufacturer name. If manufacturer doesn't exist this field is required to create a new manufacturer. |
Array of objects <Flag> (Flag) List of flags applied to product. | |
Array of objects <ParametricValue> (ParametricValue) List of parametrics applied to product. | |
object <VariantDefinitionGroup> (VariantDefinitionGroup) Variant definition information. | |
Array of objects <Variant> (Variant) List of product variants. |
ProductCategory
Code required | string Category code. Used for category matching in Norce Commerce. |
SortOrder | integer <int32> Determines in which order this category shall be applied to product. Use sort order 1 for primary category. |
ProductCulture
CultureCode required | string Culture code, e.g. "en-GB". |
Description | string Translated product description. |
DescriptionHeader | string Translated product description header. Max length: 255 |
IsUniqueUrlNameManuallyMaintained | boolean Determines if UniqueUrlName is manually maintained. |
MetaDescription | string Translated product meta description. |
MetaTags | string Translated product meta tags. |
Name | string Translated product name. Max length: 255 |
SubDescription | string Translated additional product description. |
SubHeader | string Translated additional product header. Max length: 255 |
Synonyms | string Translated product synonymous names. |
Tags | string Translated product tags. |
Title | string Translated product title. Max length: 255 |
UniqueUrlName | string Language specific unique prodct url name, called 'Unique url' in administration gui. |
ProductFamily
Code required | string Externally defined product family code. Used for product family matching in Norce Commerce. |
Name | string Product family name. |
ProductHeader
AccountId required | integer <int32> Account which initiated the import. Learn about system accounts here. |
FullFile required | boolean If set to true all products that are not imported here will be inactivated. Missing variants will be disconnected from the product as well. |
ProductFieldsThatAreSet required | Array of strings Specifies which product fields shall be updated. |
IgnoreSkuPriceListFieldsWhenEmpty | Array of strings Specifies which SKU price list fields that are mandatory. If this field is missing in the import this specific price entity will be ignored. |
JobId | string Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request. |
ProductCultureFieldsThatAreSet | Array of strings Specifies which product culture fields to be updated. |
SerializationType | Array of strings Request serialization type.(Use the integer instead of the name for the xml content type) |
SkuCultureFieldsThatAreSet | Array of strings Specifies which SKU culture fields to be updated. |
SkuFieldsThatAreSet | Array of strings Specifies which SKU fields to be updated. |
SkuPriceListFieldsThatAreSet | Array of strings Specifies which SKU price list fields to be updated. |
SkuStructureItemFieldsThatAreSet | Array of strings Specifies which SKU structure item fields to be updated. |
StorageName | string <uri> Location of the import file on Norce's file area. Can be used instead of sending data directly in payload. |
SupplierId | integer <int32> Derived from base header. Ignored in product import. |
VariantCultureFieldsThatAreSet | Array of strings Specifies which variant culture fields to be updated. |
VariantFieldsThatAreSet | Array of strings Specifies which variant fields to be updated. |
Relation
PartNo required | string Part number for the SKU with relations. |
RelatedPartNo required | string Part number for the related SKU. |
RelationTypeCode required | string Code for the desired client defined relation type. |
Array of objects <RelationCulture> (RelationCulture) List of cultures for the relation. | |
IsActive | boolean Sets the relation to active or inactive. |
IsRelatedVariantUnique | boolean True if the related product is variant unique. |
IsVariantUnique | boolean True if the relation is variant unique. |
SortOrder | integer <int32> Sort order for this relation on the SKU. |
RelationCulture
CultureCode required | string Culture code for this specific culture (e.g. "en-US") |
Description | string Description for the relation. |
DescriptionHeader | string Description header for the relation. |
Name | string Relation name |
SubDescription | string Sub description for the relation. |
SubHeader | string Sub header for the relation. |
RelationHeader
AccountId required | integer <int32> Account which initiated the import. Learn about system accounts here. |
FullFile required | boolean If set to true. Relations not in the file will be deactivated. |
RelationFieldsThatAreSet required | Array of strings Specifies which relation fields that should be created/updated. |
RelationCultureFieldsThatAreSet | Array of strings Specifies which relation culture fields that should be created/updated. |
Sku
PartNo required | string SKU part no. |
ActualWeight | number SKU weight. If null is imported will be set to inherit from category. |
CommodityCode | string Commodity code. |
Array of objects <SkuCulture> (SkuCulture) List of SKU information translations. | |
DiscountClass | string Discount class. |
EanCode | string EAN code, or GS1 code. |
IntegrationPartNo | string The replaceable sku in other systems than Norce Commerce. Used when Norce Commerce has SKU's other systems does not recognize and the integration partno is sent instead. |
IsBuyable | boolean Determines if SKU can be bought. |
IsDropShipOnly | boolean Determines if SKU can only be sold using drop shipment. |
IsRecommendedSalesQtyFixed | boolean Determines if recommended sales quantity is fixed. |
LogisticDepth | number SKU depth |
LogisticHeight | number SKU height |
LogisticWidth | number SKU width |
RecommendedSalesQty | number Recommended sales quantity |
object <SkuPriceList> (SkuPriceList) SKU price information. Send to Norce Commerce the price information that should be updated. Use the header fields to control what is updated. Any values that are null or 0 will be ignored (not overwrite current value in Norce), but if the field (e.g. PriceSale) is listed in IgnoreSkuPriceListFieldsWhenEmpty will cause the entire price entity to be ignored. | |
StartDate | string <DateTime> SKU activation time. |
Status | integer <int32> SKU status. |
StopDate | string <DateTime> SKU deactivation time. |
Array of objects <SkuStructureItem> (SkuStructureItem) List of items included in SKU structure. | |
TrackingCode | string Tracking code. |
Type | integer SKU type. |
UnitOfMeasurementCount | number Number of units in the specified type. |
UnitOfMeasurementType | integer Unit of measurement type. |
Array of objects <VatRate> (VatRate) List of VAT rates applicable for SKU. | |
VolumeWeight | number Deprecated. If required add as parameter instead. |
SkuCulture
CultureCode required | string Culture code, e.g. "en-GB" |
Comment | string Translated comment. |
ErpName | string Translated ERP name. |
SkuOnhand
LocationCode required | string Location code. Used for SKU location matching in Norce Commerce. |
PartNo required | string SKU part number. |
WarehouseCode required | string Warehouse code. Used for warehouse matching in Norce Commerce. |
IncomingValue | number Quantity of items that is purchased from a supplier but not yet recevied to the warehouse. |
Array of objects <Info> (Info) Additional on hand information defined by 3rd party and configured in Norce Commerce administration GUI. | |
IsActive | boolean Sets warehouse SKU information to active or inactive. |
LeadTimeDayCount | integer <int32> Indication of time required for delivery from this warehouse for this product. |
MaximumValue | number Target stock level (max value) |
MinimumValue | number Reorder point (min value) |
NextDeliveryDate | string <DateTime> Determines when the next delivery of items to warehouse is expected to occur. |
OnOrderValue | number Deprecated |
OnhandValue | number Quantity of items on the shelf in the specified warehouse. |
SkuOnhandHeader
AccountId required | integer <int32> Account which initiated the import. Learn about system accounts here. |
FullFile required | boolean If set to true, all onHand records for the warehouses and locations in the import that is NOT included, will be deactivated. |
SkuOnhandFieldsThatAreSet required | Array of strings Specifies which SKU on hand fields to be updated. |
JobId | string Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request. |
SerializationType | Array of strings Request serialization type.(Use the integer instead of the name for the xml content type) |
StorageName | string Location of the import file on Norce's file area. Can be used instead of sending data directly in payload. |
SupplierId | integer <int32> Derived from base header. Ignored in on hand import. |
SkuPriceList
PartNo required | string SKU part number. |
PriceListCode required | string Agreement code on the price list. Used for matching in Norce Commerce. |
CostPurchase | number Purchase cost from supplier. |
CostUnit | number Unit cost. |
CurrencyCode | string Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". |
IsActive | boolean Sets SKU price to active or inactive. |
IsPriceDiscountable | boolean Determines if discounts can be applied to the price. |
PriceCatalog | number Catalog price. |
PricePrevious | number Previous price. Can be used to show discounts. |
PriceRecommended | number Recommended sale price. |
PriceRule | integer <int32> Price rule for this SKU. |
PriceRuleValue | number Value to apply for selected Price Rule. |
PriceSale | number Sale price. |
QuantityBreak | integer <int32> Threshold which determines minimum quantity of items required for specified price list to be applied. |
SkuPriceListHeader
AccountId required | integer <int32> Account which initiated the import. Learn about system accounts here. |
FullFile required | boolean If set to true, all price records for the price lists in the import that is NOT included, will be deactivated. |
IgnoreSkuPriceListFieldsWhenEmpty | Array of strings Specifies which SKU price list fields that are mandatory. If this field is missing in the import this specific price entity will be ignored. |
SkuPriceListFieldsThatAreSet required | Array of strings Specifies which SKU price list fields to be updated. |
JobId | string Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request. |
SerializationType | Array of strings Request serialization type.(Use the integer instead of the name for the xml content type) |
StorageName | string <uri> Location of the import file on Norce's file area. Can be used instead of sending data directly in payload. |
SupplierId | integer <int32> Derived from base header. Ignored in SKU price list import. |
SkuStructureItem
PartNo required | string Part number of item to add to structure |
Quantity required | number Quantity of items included in structure |
StructurePartNo required | string Structure item part number, the parent package part number. |
Array of objects <Info> (Info) List of additional 3rd party information fields. | |
SortOrder | integer <int32> Item sort order in structure. |
object <SkuStructureItemPriceList> (SkuStructureItemPriceList) Structure item price list information. |
SkuStructureItemPriceList
CurrencyCode required | string Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". |
ItemPriceListCode required | string Structure item price list code. Used for price list matching in Norce Commerce. |
PartNo required | string This item part number. |
PriceListCode required | string Structure price list code (parent). Used for price list matching in Norce Commerce. |
PriceSale required | number Structure item sale price |
StructurePartNo required | string Structure item part number, the parent package part number. |
QuantityBreak | integer <int32> Minimum quantity required for a price rule to be applied. |
Variant
ManufacturerPartNo required | string Manufacturer part number. |
Array of objects <Image> (Image) List of additional images. | |
Array of objects <VariantCulture> (VariantCulture) List of translated variant information fields. | |
Array of objects <DeliveryMethod> (DeliveryMethod) List of delivery methods applicable to variant. Use this to restrict which delivery methods that is allowed on the product. | |
IsDagerousGoods | boolean Determines if a variant is dangerous goods. |
object <Image> (Image) Product image information. | |
Array of objects <VariantDefinition> (VariantDefinition) List of variant definitions. | |
Array of objects <Sku> (Sku) List of SKUs associated to variant. | |
SortOrderValue | integer <int32> Sort order of variant among all the variants. |
Array of objects <Flag> (Flag) Stock display break point. Can be used to change the stock value that is displayed. | |
Array of objects <Flag> (Flag) List of flags applied to variant. | |
Array of objects <ParametricValue> (ParametricValue) List of parametrics applied to variant. |
VariantCulture
CultureCode required | string Culture code, e.g. "en-GB". |
IsUniqueUrlNameManuallyMaintained | boolean Determines if UniqueUrlName is manually maintained. |
Name | string Translated variant name. |
UniqueUrlName | string <uri> Unique URL |
VariantDefinition
TypeCode required | string Variant type code. Used for variant type matching in Norce Commerce. |
Array of objects <VariantDefinitionCulture> (VariantDefinitionCulture) List of translated variant definitions. |
VariantDefinitionCulture
CultureCode required | string Culture code, e.g. "en-GB" |
Value required | string Translated definition value. |
VariantDefinitionGroup
Code required | string Variant definition group code. |
Name | string Variant definition group name. |
Array of objects <VariantDefinitionType> (VariantDefinitionType) List of variant definition types. |
VariantDefinitionType
Code required | string Variant definition type code. Used for variant type matching in Norce Commerce. |
Name | string Type name. |
ParametricCode | string Variant definition type parametric code. |
SortOrder | integer <int32> Sort order. |
VatRate
Rate | number VAT rate |
SalesArea required | integer <int32> Sales area identifier. |
Warehouse
Code required | string Warehouse code. Used for warehouse matching in Norce Commerce. |
required | Array of objects <WarehouseLocation> (WarehouseLocation) List of warehouse locations. |
LeadTimeDayCount | integer <int32> Indication of time required for delivery |
Name | string Warehouse name. |
Type | integer <int32> Warehouse type. |
WarehouseLocation
Code required | string Location code. Used for location matching in Norce Commerce. |
IsIncludedInStockCalculation | boolean Determines if a location is part of central warehouse stock calculation. |
LeadTimeDayCount | integer <int32> Indication of time required for delivery. |
Name | string Location name. |