Connect Customer schemas

Import of customer and company data.

Entities

Account

Customer account information

ApplicationKey
required
string <uuid>

Application identifier. Determines which application the account belongs to.

LoginName
required
string

Account login name

Password
string

Account password

Array of objects <AccountRole> (AccountRole)

List of account roles to assign

Status
integer <int32>

Account status: 1 = Active, 2 = Inactive (Use integers if import format is XML)

Enum: "Active" "Inactive"

AccountRole

Determines what actions account can perform

Code
required
string

Unique code of account role (e.g. Administrator, User). The role needs to exist in Norce Commerce.

IsActive
boolean

Sets account role to active or inactive. Default is true.

### Address Customer address information
AddressLine1
string

First line of address

AddressLine2
string

Second line of address

CareOf
string

Care of

City
string

City

Code
string

System agnostic identifier for the company or customer. Max length: 50

CountryCode
string

ISO country code (e.g. SE, BY). Max length: 2

Gln
string

Global Location Number. Max length: 50

IsPrimary
boolean

Set to true to indicate primary delivery address. Null will not change anything. Only one address can be marked primary.

IsValidated
boolean

Set to true to indicate that the address has been validated. Null will not change anything.

Region
string

Region

ShippingPhoneNumber
string

Phone number for shipping notifications (if used as delivery address). Max length: 50

ZipCode
string

Zip code

Company

Company information

ApplicationKey
required
string <uuid>

Application identifier. Determines which application company belongs to.

Array of objects <Info> (Info)

List of additional information fields

Code
string

Company code. Used for company matching if Norce Commerce company id is omitted.

Array of objects <Contact> (Contact)

List of company contacts

Array of objects <Customer> (Customer)

List of customers belonging to company. Customers must exist already in Norce Commerce to be added as a relation to this Company. Any identifier can be used and they are ordered as Id, Code, EmailAddress. The first that is given will be used.

Array of objects <Address> (Address)

List of delivery addresses

Array of objects <DeliveryMethod> (DeliveryMethod)

List of delivery methods applicable to company

Array of objects <Discount> (Discount)

List of company discounts

EmailAddress
string

Contact email address

Array of objects <Flag> (Flag)

List of company flags

Id
integer <int32>

Norce Commerce's internal company id

object <Address> (Address)

Company or customer address information

IsActive
boolean

Sets company to active or inactive. Default is true.

IsCustomerListDelta
boolean

If false customers that are not provided for this company in request will be deactivated from the relation to this Company. Default is false.

object <Image> (Image)

Image information

Name
string

Company name

OrganizationNo
string

Organization number. Used for company matching if Norce Commerce's internal company id and company code are omitted and SearchOnlyByCode is false in header.

ParentCompanyCode
string

Can be used for setting parent company (if exists)

Array of objects <PaymentMethod> (PaymentMethod)

List of company payment methods

PhoneNumber
string

Contact phone number

Array of objects <PriceList> (PriceList)

List of company price lists

VatNo
string

Vat Number

UseInvoiceAddressAsDeliveryAddress
boolean

Use in conjunction with an invoice address to set the delivery address to the same as the invoice address. Both must be active for the import.

CompanyIdentifier

Company identifier when matching company. Used to match companies to customers. The first found identifier will be used. At least one must be provided.

Code
string

Company code. Used for company matching if Norce Storm company id is omitted.

Id
integer <int32>

Norce [Storm]'s internal company id

IsPrimary
boolean

Sets company as primary for the customer. Default is false.

Name
string

Company name

OrganizationNo
string

Organization number. Used for company matching if Norce [Storm]'s internal company id and company code are omitted and SearchOnlyByCode is false in header.

Contact

Company contact information

Code
required
string

Contact code. Used for contact matching.

IsActive
boolean

Sets contact to active or inactive. Default true.

Customer

Customer information

Array of objects <Account> (Account)

List of registered customer accounts

Array of objects <Info> (Info)

List of additional information fields

ApplicationKey
string <uuid>

Application identifier. Determines which application company belongs to.

CellPhoneNumber
string

Mobile phone number

Code
string

Customer code. Used for customer matching if Norce Commerce's internal customer id is omitted.

Array of objects <CompanyIdentifier> (CompanyIdentifier)

List of companies belonging to this customer. Companies must exist already in Norce Commerce to be added as a relation to this Customer. Any identifier can be used and they are ordered as Id, Code, OrganizationNo. The first that is given will be used. If more than one is marked IsPrimary then only the first will be marked as primary.

CrmId
string

Used to save the customer external id from a crm-system

Array of objects <Address> (Address)

Delivery address

EmailAddress
string

Customer email address. Used for customer matching if Norce Commerce customer id and code is omitted and SearchOnlyByCode is false in header.

FirstName
string

First name

Array of objects <Flag> (Flag)

Customer flags

Id
integer <int32>

Norce Commerce's internal customer id

object <Address> (Address)

Company or customer address information

IsActive
boolean

Sets customer to active or inactive. Default is true.

IsCompanyListDelta
boolean

If false companies that are not provided for this customer in request will be deactivated from the relation to this Company. Default is false.

LastName
string

Last name

MiddleName
string

Middle name

PhoneNumber
string

Phone number

Array of objects <PriceList> (PriceList)

Customer price lists

SocialSecurityNumber
string

Social security number

Title
string

Title

Type
integer <int32>

Customer type: 1 = Customer, 2 = Company contact

CustomerHeader

Import meta information

AccountId
required
integer <int32>

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

CompanyFieldsThatAreSet
required
Array of strings

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

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)

Items Enum: "ApplicationKey" "Id" "Code" "OrganizationNo" "Name" "EmailAddress" "PhoneNumber" "LogoImage" "ParentCompanyCode" "IsActive" "InvoiceAddress" "DeliveryAddresses" "AdditionalInfo" "Contacts" "Customers" "DeliveryMethods" "Discounts" "Flags" "PaymentMethods" "PriceLists" "SearchOnlyByCode" "VatNo" "PreserveFlags"
CustomerFieldsThatAreSet
required
Array of strings

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

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)

Items Enum: "ApplicationKey" "Code" "EmailAddress" "SocialSecurityNumber" "Title" "FirstName" "MiddleName" "LastName" "PhoneNumber" "CellPhoneNumber" "IsActive" "InvoiceAddress" "DeliveryAddresses" "Accounts" "AdditionalInfo" "Flags" "PriceLists" "SearchOnlyByCode" "Companies" "CrmId" "PreserveFlags"
AccountFieldsThatAreSet
Array of strings

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)

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)

Items Enum: "PasswordCreateOnly" "Status" "StatusCreateOnly" "Roles" "RolesCreateOnly"
JobId
string <int32>

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

SerializationType
Array of strings

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

0 = JSON, 1 = XML

Items Enum: "JSON" "XML"
StorageName
string <uri>

Location of the import file on Norce's file area. Can be used instead of sending data directly in payload.

SupplierId
string <int32>

Derived from base header. Ignored in this import.

DeliveryMethod

Company delivery method information

Code
required
string

Delivery method code

IsActive
boolean

Sets delivery method to active or inactive. Default is true.

Discount

Discount rules applied to a specific company

DiscountPercentage
number

Value of the discount (in percent)

PriceListTypeIdSeed
string

Comma separated list of price list types

Type
string <int32>

Type of discount: 1 = Category, 2 = Product Discount Class, 3 = Product Flag

ValueCode
string

Value code, for Category type this is the category code. For Discount class its the class identifier used in Norce Commerce.

Flag

Company flag

Code
required
string

Flag code. Used for flag matching.

IsActive
boolean

Sets flag to active or inactive. Default is true.

IsCreateOnly
boolean

If true, data is only saved if flag record is new. Default is false.

IsLimitedUpdate
boolean

If true, data is only saved if flag record is new or last updated by the same account as the one initiating the update. Default is false.

StopDate
string <DateTime>

Sets the stop date explicitly for inactivated flags. Time of process is used as default.

Image

Image information

ExternalCode
required
string

Code for image matching

FileTypeName
required
string

File type. Should match file info set up in Norce Commerce, e.g. MainImage, Additional, Embedded.

Url
required
string <uri>

URL where image should be taken from

Filename
string

Image file name. If omitted will be parsed form URL.

LastModified
string <DateTime>

Time when image was changed. Should be set to synchronize image updates.

Info

Additional information field

Code
required
string

Information field code. Used for info matching.

Value
required
string

Value to set

PaymentMethod

Payment method applied to company

Code
required
string

Payment method code. Used for payment method matching.

InvoiceCaptureSettingsCode
string

Used for specifying the invoice capture setting to use.

IsActive
boolean

Sets payment method relation to active or inactive. Default true.

PriceList

Customer or company specific price list

Code
required
string

Price list code. Used for price list matching.

IsExclusive
boolean

Determines if price list is exclusive, an exclusive price list overrides best price calculation in Norce Commerce API.