Skip to content
Last updated

JSON or XML serialized string of the ProductHeader object. Note that the enums must be of integer values when using application/xml. Encoding and can be either string or integer for application/json. Also note that this must be a single string without line breaks and all values in the arrays should be comma separated. Omit properties not used.

Specification

{
  "AccountId":                          integer,
  "FullFile":                           boolean,
  "ProductFieldsThatAreSet":            [integer|string],
  "ProductCultureFieldsThatAreSet":     [integer|string],
  "VariantFieldsThatAreSet":            [integer|string],
  "VariantCultureFieldsThatAreSet":     [integer|string],
  "SkuFieldsThatAreSet":                [integer|string],
  "SkuCultureFieldsThatAreSet":         [integer|string],
  "SkuPriceListFieldsThatAreSet":       [integer|string],
  "SkuStructureItemFieldsThatAreSet":   [integer|string],
  "IgnoreSkuPriceListFieldsWhenEmpty":  [integer|string],
  "JobId":                              integer,
  "SerializationType":                  integer|string,
  "StorageName":                        string,
  "SupplierId":                         integer
}

Example

{"AccountId":1,"FullFile":false,"ProductFieldsThatAreSet":[0,1,4,6],"VariantFieldsThatAreSet":[0,4,5],"VariantCultureFieldsThatAreSet":[0,1,10],"SkuFieldsThatAreSet":[1,2,7,8,20,21],"SkuCultureFieldsThatAreSet":[0],"SkuPriceListFieldsThatAreSet":[5,6,10],"SerializationType":0,"IgnoreSkuPriceListFieldsWhenEmpty":[6,10]}

AccountId

integer Required.

Account id of the integration service which initiated the import. Learn about system accounts here.

FullFile

boolean Required.

If set to true all products previously in a variant cluster that is not in the cluster (i.e. without code) in this import will be removed from the cluster. Use with caution and if you're ever unsure please set this to false.

ProductFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which product fields shall be updated.

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0ManufacturerCode
1ManufacturerName
2Alias
3Code
4VariantsRequired if you have VariantFieldsThatAreSet values
5CulturesRequired if you have ProductCultureFieldsThatAreSet values
6Categories
7MainImage
8AdditionalImages
9Family
10ProductParametrics
11ProductParametricsCreateOnlyValue is only set if the product parametric entity is created by this import
12VariantDefinitionGroup
13VariantDefinitionGroupCreateOnlyValue is only set if the variant definition entity is created by this import
14Assortment
15CategoriesCreateOnlyValue is only set if the product category entities is created by this import
16CategoriesLimitedUpdateIf category is manually changed in the Admin UI import is ignored
17AdditionalImagesCleanUpRemove all additional images not included in the import
18ParametricsCleanUpRemove all parametrics from the entity, not included in the import
19ImagesAndFilesCleanupRemove all additional images and files not included in the import

ProductCultureFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which product culture fields to be updated.

Required setting: Culture (in ProductFieldsThatAreSet)

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0Name
1NameCreateOnlyValue is only set if the product culture entity is created by this import
2SubHeader
3SubDescription
4DescriptionHeader
5Description
6DescriptionCreateOnlyValue is only set if the product culture entity is created by this import
7Synonyms
8Title
9Tags
10MetaTags
11MetaDescription
12NameLimitedUpdateName will only be updated if this account id was the last to update the name
13UniqueUrlName
14IsUniqueUrlNameManuallyMaintained
15UniqueUrlNameCreateOnlyValue is only set if the product culture entity is created by this import

ProductCultureFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which product culture fields to be updated.

Required setting: Culture (in ProductFieldsThatAreSet)

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0Name
1NameCreateOnlyValue is only set if the product culture entity is created by this import
2SubHeader
3SubDescription
4DescriptionHeader
5Description
6DescriptionCreateOnlyValue is only set if the product culture entity is created by this import
7Synonyms
8Title
9Tags
10MetaTags
11MetaDescription
12NameLimitedUpdateName will only be updated if this account id was the last to update the name
13UniqueUrlName
14IsUniqueUrlNameManuallyMaintained
15UniqueUrlNameCreateOnlyValue is only set if the product culture entity is created by this import

VariantFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which variant fields to be updated.

Required setting: Variant (in ProductFieldsThatAreSet)

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0ManufacturerPartNo
1SortOrderValue
2StockDisplayBreakPoint
3IsDangerousGoods
4CulturesRequired if you have VariantCultureFieldsThatAreSet values
5SkusRequired if you have SkuFieldsThatAreSet values
6MainImage
7AdditionalImages
8VariantParametrics
9VariantParametricsCreateOnlyValue is only set if the variant cluster entity is created by this import
10NonParametricVariantDefinitions
11NonParametricVariantDefinitionsCreateOnlyValue is only set if the variant cluster entity is created by this import
12DeliveryMethods
13DeliveryMethodsCreateOnlyValue is only set if the variant cluster entity is created by this import
14AdditionalImagesCleanUpRemove all AdditionalImages from the entity, not included in this import
15ParametricsCleanUpRemove all Parametrics from the entity, not included in this import
16TranslationRequested
17ImagesAndFilesCleanupRemove all additional images and files not included in this import

VariantCultureFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which variant culture fields to be updated.

Required setting: Cultures (in VariantFieldsThatAreSet) and for anything except Name and UniqueUrl the Client Setting Product texts are variant unique must be active.

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0CultureCode
1Name
2NameCreateOnlyValue is only set if the variant cluster culture entity is created by this import
3NameLimitedUpdateName will only be updated if this account id was the last to update the name
4UniqueUrlName
5IsUniqueUrlNameManuallyMaintained
6UniqueUrlNameCreateOnlyValue is only set if the variant cluster culture entity is created by this import
7SubHeader
8SubDescription
9DescriptionHeader
10Description
11DescriptionCreateOnlyValue is only set if the variant cluster culture entity is created by this import
12Synonyms
13Title
14Tags
15MetaTags
16MetaDescription

SkuFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which SKU fields to be updated.

Required setting: Skus (in VariantFieldsThatAreSet)

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0Name
1Status
2Type
3IntegrationPartNo
4CommodityCode
5EanCode
6TrackingCode
7UnitOfMeasurementType
8UnitOfMeasurementCount
9IsDropShipOnly
10IsBuyable
11DiscountClass
12RecommendedSalesQty
13IsRecommendedSalesQtyFixed
14ActualWeight
15VolumeWeightDeprecated, not supported any longer
16LogisticWidth
18LogisticHeight
19LogisticDepth
20StandardPriceRequired if you have SkuPriceListFieldsThatAreSet values
21VatRate
22StatusCreateOnlyValue is only set if the SKU entity is created by the import
23StartDate
24StopDate
25StructureItemsRequired if you have SkuStructureItemFieldsThatAreSet values
26PartNoCreateWhenMissingLet's Norce automatically assign a unique PartNo

SkuCultureFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which SKU culture fields to be updated.

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
0ErpName
1ErpNameCreateOnlyValue is only set if the SKU culture entity is created by this import
2Comment
3CommentCreateOnlyValue is only set if the SKU culture entity is created by this import

SkuPriceListFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings that specifies which SKU price list fields to be updated.

Required setting: StandardPrice in (SkuFieldsThatAreSet)

Use the integer instead of the name for the xml content type

Integer ValueCodeRemark
3PriceSale
4CostPurchase
5CostUnit
6PriceRecommended
7PricePrevious
8PriceCatalog
9IsPriceDiscountable
10IsActive
11IsPriceDiscountableCreateOnlyValue is only set if the SKU price list entity is created by this import
12PriceRule

SkuStructureItemFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings specifies which SKU structure item fields to be updated.

Required setting: StructureItems in (SkuFieldsThatAreSet)

Use the integer instead of the name for the xml content type

Integer ValueCode
0SortOrder
1StandardStructureItemPrice
2AdditionalInfo

IgnoreSkuPriceListFieldsWhenEmpty

[integer|string] Required.

Comma separated array of integers or strings that specifies which SKU price list fields that are mandatory. If this field is missing in the import this specific price entity will be ignored.

Required setting: StandardPrice in (SkuFieldsThatAreSet) and all fields added here must be set in SkuPriceListFieldsThatAreSet as well

Use the integer instead of the name for the xml content type

Integer ValueCode
3PriceSale
4CostPurchase
5CostUnit
6PriceRecommended
7PricePrevious
8PriceCatalog
10IsActive

JobId

integer - Optional

Internal Norce Commerce id for this job. Created automatically by Norce Commerce Connect. Should be omitted in the import request.

SerializationType

integer|string - Optional

Request serialization type. (Use the integer instead of the name for the xml content type)

0 = JSON, 1 = XML

StorageName

string <uri> - Optional

Location of the import file on Norce's file area. Can be used instead of sending data directly in payload. This requires another process of file uploads agreed with Norce to work.

SupplierId

integer - Optional

Only used in combination with StorageName above.