# ProductHeader specification

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


```json
{
  "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


```json
{"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](/developer-portal/system-integration/calling-norce-commerce-connect#using-system-accounts).

### 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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `ManufacturerCode` |  |
| 1 | `ManufacturerName` |  |
| 2 | `Alias` |  |
| 3 | `Code` |  |
| 4 | `Variants` | Required if you have VariantFieldsThatAreSet values |
| 5 | `Cultures` | Required if you have ProductCultureFieldsThatAreSet values |
| 6 | `Categories` |  |
| 7 | `MainImage` |  |
| 8 | `AdditionalImages` |  |
| 9 | `Family` |  |
| 10 | `ProductParametrics` |  |
| 11 | `ProductParametricsCreateOnly` | Value is only set if the product parametric entity is created by this import |
| 12 | `VariantDefinitionGroup` |  |
| 13 | `VariantDefinitionGroupCreateOnly` | Value is only set if the variant definition entity is created by this import |
| 14 | `Assortment` |  |
| 15 | `CategoriesCreateOnly` | Value is only set if the product category entities is created by this import |
| 16 | `CategoriesLimitedUpdate` | If category is manually changed in the Admin UI import is ignored |
| 17 | `AdditionalImagesCleanUp` | Remove all additional images not included in the import |
| 18 | `ParametricsCleanUp` | Remove all parametrics from the entity, not included in the import |
| 19 | `ImagesAndFilesCleanup` | Remove 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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `Name` |  |
| 1 | `NameCreateOnly` | Value is only set if the product culture entity is created by this import |
| 2 | `SubHeader` |  |
| 3 | `SubDescription` |  |
| 4 | `DescriptionHeader` |  |
| 5 | `Description` |  |
| 6 | `DescriptionCreateOnly` | Value is only set if the product culture entity is created by this import |
| 7 | `Synonyms` |  |
| 8 | `Title` |  |
| 9 | `Tags` |  |
| 10 | `MetaTags` |  |
| 11 | `MetaDescription` |  |
| 12 | `NameLimitedUpdate` | Name will only be updated if this account id was the last to update the name |
| 13 | `UniqueUrlName` |  |
| 14 | `IsUniqueUrlNameManuallyMaintained` |  |
| 15 | `UniqueUrlNameCreateOnly` | Value 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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `Name` |  |
| 1 | `NameCreateOnly` | Value is only set if the product culture entity is created by this import |
| 2 | `SubHeader` |  |
| 3 | `SubDescription` |  |
| 4 | `DescriptionHeader` |  |
| 5 | `Description` |  |
| 6 | `DescriptionCreateOnly` | Value is only set if the product culture entity is created by this import |
| 7 | `Synonyms` |  |
| 8 | `Title` |  |
| 9 | `Tags` |  |
| 10 | `MetaTags` |  |
| 11 | `MetaDescription` |  |
| 12 | `NameLimitedUpdate` | Name will only be updated if this account id was the last to update the name |
| 13 | `UniqueUrlName` |  |
| 14 | `IsUniqueUrlNameManuallyMaintained` |  |
| 15 | `UniqueUrlNameCreateOnly` | Value 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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `ManufacturerPartNo` |  |
| 1 | `SortOrderValue` |  |
| 2 | `StockDisplayBreakPoint` |  |
| 3 | `IsDangerousGoods` |  |
| 4 | `Cultures` | Required if you have VariantCultureFieldsThatAreSet values |
| 5 | `Skus` | Required if you have SkuFieldsThatAreSet values |
| 6 | `MainImage` |  |
| 7 | `AdditionalImages` |  |
| 8 | `VariantParametrics` |  |
| 9 | `VariantParametricsCreateOnly` | Value is only set if the variant cluster entity is created by this import |
| 10 | `NonParametricVariantDefinitions` |  |
| 11 | `NonParametricVariantDefinitionsCreateOnly` | Value is only set if the variant cluster entity is created by this import |
| 12 | `DeliveryMethods` |  |
| 13 | `DeliveryMethodsCreateOnly` | Value is only set if the variant cluster entity is created by this import |
| 14 | `AdditionalImagesCleanUp` | Remove all AdditionalImages from the entity, not included in this import |
| 15 | `ParametricsCleanUp` | Remove all Parametrics from the entity, not included in this import |
| 16 | `TranslationRequested` |  |
| 17 | `ImagesAndFilesCleanup` | Remove 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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `CultureCode` |  |
| 1 | `Name` |  |
| 2 | `NameCreateOnly` | Value is only set if the variant cluster culture entity is created by this import |
| 3 | `NameLimitedUpdate` | Name will only be updated if this account id was the last to update the name |
| 4 | `UniqueUrlName` |  |
| 5 | `IsUniqueUrlNameManuallyMaintained` |  |
| 6 | `UniqueUrlNameCreateOnly` | Value is only set if the variant cluster culture entity is created by this import |
| 7 | `SubHeader` |  |
| 8 | `SubDescription` |  |
| 9 | `DescriptionHeader` |  |
| 10 | `Description` |  |
| 11 | `DescriptionCreateOnly` | Value is only set if the variant cluster culture entity is created by this import |
| 12 | `Synonyms` |  |
| 13 | `Title` |  |
| 14 | `Tags` |  |
| 15 | `MetaTags` |  |
| 16 | `MetaDescription` |  |


### 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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `Name` |  |
| 1 | `Status` |  |
| 2 | `Type` |  |
| 3 | `IntegrationPartNo` |  |
| 4 | `CommodityCode` |  |
| 5 | `EanCode` |  |
| 6 | `TrackingCode` |  |
| 7 | `UnitOfMeasurementType` |  |
| 8 | `UnitOfMeasurementCount` |  |
| 9 | `IsDropShipOnly` |  |
| 10 | `IsBuyable` |  |
| 11 | `DiscountClass` |  |
| 12 | `RecommendedSalesQty` |  |
| 13 | `IsRecommendedSalesQtyFixed` |  |
| 14 | `ActualWeight` |  |
| 15 | `VolumeWeight` | Deprecated, not supported any longer |
| 16 | `LogisticWidth` |  |
| 18 | `LogisticHeight` |  |
| 19 | `LogisticDepth` |  |
| 20 | `StandardPrice` | Required if you have SkuPriceListFieldsThatAreSet values |
| 21 | `VatRate` |  |
| 22 | `StatusCreateOnly` | Value is only set if the SKU entity is created by the import |
| 23 | `StartDate` |  |
| 24 | `StopDate` |  |
| 25 | `StructureItems` | Required if you have SkuStructureItemFieldsThatAreSet values |
| 26 | `PartNoCreateWhenMissing` | Let'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 Value | Code | Remark |
|  --- | --- | --- |
| 0 | `ErpName` |  |
| 1 | `ErpNameCreateOnly` | Value is only set if the SKU culture entity is created by this import |
| 2 | `Comment` |  |
| 3 | `CommentCreateOnly` | Value 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 Value | Code | Remark |
|  --- | --- | --- |
| 3 | `PriceSale` |  |
| 4 | `CostPurchase` |  |
| 5 | `CostUnit` |  |
| 6 | `PriceRecommended` |  |
| 7 | `PricePrevious` |  |
| 8 | `PriceCatalog` |  |
| 9 | `IsPriceDiscountable` |  |
| 10 | `IsActive` |  |
| 11 | `IsPriceDiscountableCreateOnly` | Value is only set if the SKU price list entity is created by this import |
| 12 | `PriceRule` |  |


### 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 Value | Code |
|  --- | --- |
| 0 | `SortOrder` |
| 1 | `StandardStructureItemPrice` |
| 2 | `AdditionalInfo` |


### 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 Value | Code |
|  --- | --- |
| 3 | `PriceSale` |
| 4 | `CostPurchase` |
| 5 | `CostUnit` |
| 6 | `PriceRecommended` |
| 7 | `PricePrevious` |
| 8 | `PriceCatalog` |
| 10 | `IsActive` |


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