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.

Specification

{
    "AccountId": <integer>,
    "CompanyFieldsThatAreSet": [string|integer],
    "CustomerFieldsThatAreSet": [string|integer],
    "AccountFieldsThatAreSet": [string],
    "JobId": <integer>,
    "SerializationType": [string],
    "StorageName": [string],  
    "SupplierId": [string]
}

AccountId

integer Required.

Account which initiated the import. Learn about system accounts here.

CompanyFieldsThatAreSet

[string|integer] Required.

Array of strings representing company fields to be processed

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

Not required for ImportCustomers.

Integer Value	Code
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 be left on the entity, otherwise they will be removed and replaced with the ones imported)

CustomerFieldsThatAreSet

[string|integer] Required

Array of 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
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 be left on the entity, otherwise they will be removed and replaced with the ones imported)

AccountFieldsThatAreSet

[string] - Optional

Array of strings representing account fields to be processed.

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

Not required for ImportCompanies

Required settings: Accounts (in CustomerFieldsThatAreSet)

Integer Value	Code
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

Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request.

SerializationType

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

SupplierId

string <int32> - Optional Derived from base header. Ignored in this import.