Last updated

PriceListHeader specification

JSON or XML serialized string of the PriceListHeader 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,
  "PriceListFieldsThatAreSet":          [integer|string],
  "PriceListRuleFieldsThatAreSet":      [integer|string],
  "WarehouseFieldsThatAreSet":          [integer|string],
  "WarehouseLocationFieldsThatAreSet":  [integer|string],
  "JobId":                              integer,
  "SerializationType":                  integer|string,
  "StorageName":                        string,
  "SupplierId":                         integer
}

Example

{"AccountId":1, "FullFile":false, "PriceListFieldsThatAreSet":[0,1,2,3,4,5,8,9,12,13,14,15,18,19,21,22],"WarehouseFieldsThatAreSet":[0,1,2],"WarehouseLocationFieldsThatAreSet":[0,1,2],"PriceListPriceRuleFieldsThatAreSet":[0,1,2]}

AccountId

integer Required.

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

PriceListFieldsThatAreSet

[integer|string] Required.

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

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

Integer ValueCodeRemarks
0Name
1CurrencyCode
2StartDate
3EndDate
4IsPublic
5IsPrimary
6TypeCode
7Warehouses
8DefaultPriceRule
9Description
11DoNotCreateApplicationPriceList
12SalesArea
13DefaultMinMarginPercent
14LimitToRecPrice
15ParentPriceListCode
16DefaultSupplementalChargeFixed
17DefaultSupplementalChargePercent
18PriceRules
19PriceRulesCleanupRemove existing rules on the pricelist not included in this import.
20PriceRulesLimitedUpdateOnly update rules if they were created or updated by this account id.
21Population
22PopulationCleanupRemove existing rules for population not included in this import.
23IsFavorite
24InheritStructureCalculationRule

PriceListPriceRuleFieldsThatAreSet

[integer|string]

Comma separated array of integers or strings that specifies which SKU price list fields that are mandatory.

Required setting: PriceRules[Cleanup|LimitedUpdate] (in PriceListFieldsThatAreSet)

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

Integer ValueCode
0Type
1Value
2LimitToRecPrice
3SupplementalChargeFixed
4SupplementalChargePercent

A price list can have multiple PriceRules entries, each scoped to a different subset of products via restriction fields. Unlike the fields above, restriction fields are plain properties on each PriceListPriceRule entry — they don't need to be declared in PriceListPriceRuleFieldsThatAreSet, just include them directly when relevant:

FieldDescription
MinValue / MaxValueRestricts the rule to products whose price falls within this range.
ManufacturerCodeRestricts the rule to a specific manufacturer.
CategoryCodeRestricts the rule to a specific category.
FlagsRestricts the rule to products carrying these flag codes.

This is how a single price list can apply different margin/discount logic to different manufacturers, categories, or flagged products at once.

No IsIncludingVat field

There is no field or flag on ImportPriceLists to make a price list VAT-inclusive — Norce always stores prices excluding VAT. VAT is applied at read time based on the sales area/VAT code configuration, not on the price list itself. See VAT and Sales Areas.

WarehouseFieldsThatAreSet

[integer|string]

Comma separated array of integers or strings that specifies which SKU price list fields that are mandatory.

Required setting: Warehouses (in PriceListFieldsThatAreSet)

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

Integer ValueCode
0Type
1Name
2LeadTimeDayCount

WarehouseLocationFieldsThatAreSet

[integer|string]

Comma separated array of integers or strings that specifies which SKU price list fields that are mandatory.

Required setting: Warehouses (in PriceListFieldsThatAreSet)

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

Integer ValueCode
0Name
1LeadTimeDayCount
2IsIncludedInStockCalculation

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.