Last updated

Connect Customer schemas

Import of customer and company data.

Entities

Account

Customer account information

ApplicationKeystring(uuid)required

Application identifier. Determines which application the account belongs to.

LoginNamestringrequired

Account login name

Passwordstring

Account password

RolesArray of objects(AccountRole)(AccountRole)

List of account roles to assign

Statusinteger(int32)

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

AccountRole

Determines what actions account can perform

Codestringrequired

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

IsActiveboolean

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

Address

Customer address information

AddressLine1string

First line of address

AddressLine2string

Second line of address

CareOfstring

Care of

Citystring

City

Codestring

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

CountryCodestring

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

Glnstring

Global Location Number. Max length: 50

IsPrimaryboolean

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

IsValidatedboolean

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

Regionstring

Region

ShippingPhoneNumberstring

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

ZipCodestring

Zip code

Company

Company information

ApplicationKeystring(uuid)required

Application identifier. Determines which application company belongs to.

AdditionalInfoArray of objects(Info)(Info)

List of additional information fields

Codestring

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

ContactsArray of objects(Contact)(Contact)

List of company contacts

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

DeliveryAddressesArray of objects(Address)(Address)

List of delivery addresses

DeliveryMethodsArray of objects(DeliveryMethod)(DeliveryMethod)

List of delivery methods applicable to company

DiscountsArray of objects(Discount)(Discount)

List of company discounts

EmailAddressstring

Contact email address

FlagsArray of objects(Flag)(Flag)

List of company flags

Idinteger(int32)

Norce Commerce's internal company id

InvoiceAddressobject(Address)(Address)

Company or customer address information

IsActiveboolean

Sets company to active or inactive. Default is true.

IsCustomerListDeltaboolean

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

LogoImageobject(Image)(Image)

Image information

Namestring

Company name

OrganizationNostring

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

ParentCompanyCodestring

Can be used for setting parent company (if exists)

PaymentMethodsArray of objects(PaymentMethod)(PaymentMethod)

List of company payment methods

PhoneNumberstring

Contact phone number

PriceListsArray of objects(PriceList)(PriceList)

List of company price lists

VatNostring

Vat Number

UseInvoiceAddressAsDeliveryAddressboolean

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.

Codestring

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

Idinteger(int32)

Norce [Storm]'s internal company id

IsPrimaryboolean

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

Namestring

Company name

OrganizationNostring

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

Codestringrequired

Contact code. Used for contact matching.

IsActiveboolean

Sets contact to active or inactive. Default true.

Customer

Customer information

AccountsArray of objects(Account)(Account)

List of registered customer accounts

AdditionalInfoArray of objects(Info)(Info)

List of additional information fields

ApplicationKeystring(uuid)

Application identifier. Determines which application company belongs to.

CellPhoneNumberstring

Mobile phone number

Codestring

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

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

CrmIdstring

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

DeliveryAddressesArray of objects(Address)(Address)

Delivery address

EmailAddressstring

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

FirstNamestring

First name

FlagsArray of objects(Flag)(Flag)

Customer flags

Idinteger(int32)

Norce Commerce's internal customer id

InvoiceAddressobject(Address)(Address)

Company or customer address information

IsActiveboolean

Sets customer to active or inactive. Default is true.

IsCompanyListDeltaboolean

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

LastNamestring

Last name

MiddleNamestring

Middle name

PhoneNumberstring

Phone number

PriceListsArray of objects(PriceList)(PriceList)

Customer price lists

SocialSecurityNumberstring

Social security number

Titlestring

Title

Typeinteger(int32)

Customer type: 1 = Customer, 2 = Company contact

CustomerHeader

Import meta information

AccountIdinteger(int32)required

Account which initiated the import. Learn about system accounts <a href='/connectintegration/#using-system-accounts'>here</a>.

CompanyFieldsThatAreSetArray of stringsrequired

Array of strings representing company fields to be processed.<br/>(Use the integer instead of the name for the xml content type)<br/>Not required for ImportCustomers<br/><br/>0 = ApplicationKey<br>1 = Id<br>2 = Code<br>3 = OrganizationNo<br>4 = Name<br>5 = EmailAddress<br>6 = PhoneNumber<br>7 = LogoImage<br>8 = ParentCompanyCode<br>9 = IsActive<br>10 = InvoiceAddress<br>11 = DeliveryAddresses<br>12 = AdditionalInfo<br>13 = Contacts<br>14 = Customers (set values in CustomerFieldsThatAreSet)<br>15 = DeliveryMethods<br>16 = Discounts<br>17 = Flags<br>18 = PaymentMethods<br>19 = PriceLists<br>20 = SearchOnlyByCode (matches the customer only on the value on the code field, allows for duplicated OrganizationNo)<br>21 = VatNo<br>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"
CustomerFieldsThatAreSetArray of stringsrequired

Array of strings representing customer fields to be processed.<br/>(Use the integer instead of the name for the xml content type)<br/>Not required for ImportCompanies, but if used there, 'Customers' must be set in CompanyFieldsThatAreSet<br/><br/>0 = ApplicationKey<br>1 = Id<br>2 = Code<br>3 = EmailAddress<br>4 = SocialSecurityNumber<br>5 = Title<br>6 = FirstName<br>7 = MiddleName<br>8 = LastName<br>9 = PhoneNumber<br>10 = CellPhoneNumber<br>11 = IsActive<br>12 = InvoiceAddress<br>13 = DeliveryAddresses<br>14 = Accounts (set values in AccountFieldsThatAreSet)<br>15 = AdditionalInfo<br>16 = Flags<br>17 = PriceLists<br>18 = SearchOnlyByCode (matches the customer only on the value on the code field, alows for duplicated email addresses)<br>19 = Companies (set values in CompanyFieldsThatAreSet)<br>20 = CrmId<br>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"
AccountFieldsThatAreSetArray of strings

Array of strings representing account fields to be processed.<br/>(Use the integer instead of the name for the xml content type)<br/>Not required for ImportCompanies<br/>Required settings: Accounts (in CustomerFieldsThatAreSet)<br/><br/>0 = PasswordCreateOnly (Value is only set if the entity is created by the import)<br>1 = Status<br>2 = StatusCreateOnly (Value is only set if the entity is created by the import)<br>3 = Roles<br>4 = RolesCreateOnly (Value is only set if the entity is created by the import)

Items Enum"PasswordCreateOnly""Status""StatusCreateOnly""Roles""RolesCreateOnly"
JobIdstring(int32)

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

SerializationTypeArray of strings

Request serialization type.(Use the integer instead of the name for the xml content type)<br/><br/>0 = JSON, 1 = XML

Items Enum"JSON""XML"
StorageNamestring(uri)

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

SupplierIdstring(int32)

Derived from base header. Ignored in this import.

DeliveryMethod

Company delivery method information

Codestringrequired

Delivery method code

IsActiveboolean

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

Discount

Discount rules applied to a specific company

DiscountPercentagenumber

Value of the discount (in percent)

PriceListTypeIdSeedstring

Comma separated list of price list types

Typestring(int32)

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

ValueCodestring

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

Flag

Company flag

Codestringrequired

Flag code. Used for flag matching.

IsActiveboolean

Sets flag to active or inactive. Default is true.

IsCreateOnlyboolean

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

IsLimitedUpdateboolean

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.

StopDatestring(DateTime)

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

Image

Image information

ExternalCodestringrequired

Code for image matching

FileTypeNamestringrequired

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

Urlstring(uri)required

URL where image should be taken from

Filenamestring

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

LastModifiedstring(DateTime)

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

Info

Additional information field

Codestringrequired

Information field code. Used for info matching.

Valuestringrequired

Value to set

PaymentMethod

Payment method applied to company

Codestringrequired

Payment method code. Used for payment method matching.

InvoiceCaptureSettingsCodestring

Used for specifying the invoice capture setting to use.

IsActiveboolean

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

PriceList

Customer or company specific price list

Codestringrequired

Price list code. Used for price list matching.

IsExclusiveboolean

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