X-StormConnect-Header specification

JSON or XML serialized string of the CustomerHeader 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,
    "CompanyFieldsThatAreSet": [integer|string],
    "CustomerFieldsThatAreSet": [integer|string],
    "AccountFieldsThatAreSet": [integer|string],
    "JobId": integer,
    "SerializationType": integer|string,
    "StorageName": string,  
    "SupplierId": integer
}

Example

{"AccountId":1,"CompanyFieldsThatAreSet":[0,2,3,4,5,6,9,10,11,14,17,18,19,20,12,22],"CustomerFieldsThatAreSet":[0,2,14,3,6,9,11,12,13],"AccountFieldsThatAreSet":[1,3,4],"SerializationType":0}

AccountId

integer Required.

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

CompanyFieldsThatAreSet

[integer|string] Required.

Comma separated array of integers or strings representing company fields to be processed.

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

Not required for ImportCustomers, but if used there, companies must be set in CustomerFieldsThatAreSet.

Integer Value	Code	Remarks
0	`ApplicationKey`
1	`Id`
2	`Code`
3	`OrganizationNo`
4	`Name`
5	`EmailAddress`
6	`PhoneNumber`
7	`LogoImage`
8	`ParentCompanyCode`
9	`IsActive`
10	`InvoiceAddress`
11	`DeliveryAddresses`
12	`AdditionalInfo`
13	`Contacts`
14	`Customers`	Set values in `CustomerFieldsThatAreSet`
15	`DeliveryMethods`
16	`Discounts`
17	`Flags`
18	`PaymentMethods`
19	`PriceLists`
20	`SearchOnlyByCode`	Matches the customer only on the value on the code field, allows for duplicated OrganizationNo
21	`VatNo`
22	`PreserveFlags`	Flags not passed in will remain on the entity, otherwise they will be replaced with imported values

CustomerFieldsThatAreSet

[integer|string] Required

Comma separated array of integers or strings representing customer fields to be processed.

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

Not required for ImportCompanies, but if used there, customers must be set in CompanyFieldsThatAreSet.

Integer Value	Code	Remarks
0	`ApplicationKey`
1	`Id`
2	`Code`
3	`EmailAddress`
4	`SocialSecurityNumber`
5	`Title`
6	`FirstName`
7	`MiddleName`
8	`LastName`
9	`PhoneNumber`
10	`CellPhoneNumber`
11	`IsActive`
12	`InvoiceAddress`
13	`DeliveryAddresses`
14	`Accounts`	Set values in `AccountFieldsThatAreSet`
15	`AdditionalInfo`
16	`Flags`
17	`PriceLists`
18	`SearchOnlyByCode`	Matches the customer only on the value on the code field, alows for duplicated email addresses
19	`Companies`	Set values in `CompanyFieldsThatAreSet`
20	`CrmId`
21	`PreserveFlags`	Flags not passed in will remain on the entity, otherwise they will be replaced with imported values

AccountFieldsThatAreSet

[integer|string] - Optional

Comma separated array of integers or strings representing account fields to be processed.

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

Not required for ImportCompanies.

Required setting: Accounts (in CustomerFieldsThatAreSet)

Integer Value	Code	Remarks
0	`PasswordCreateOnly`	Value is only set if the entity is created by the import
1	`Status`
2	`StatusCreateOnly`	Value is only set if the entity is created by the import
3	`Roles`
4	`RolesCreateOnly`	Value is only set if the entity is created by the import

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