Documentation Norce [Storm] Connect Customer Service (4.0)

The Customer Service has Entities and Operations concerned with Customers and Companies in Norce Commerce.

Download OpenAPI description
Languages
Servers

https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Schemas

CustomerHeader

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.

{ "AccountId": 0, "CompanyFieldsThatAreSet": [ "ApplicationKey" ], "CustomerFieldsThatAreSet": [ "ApplicationKey" ], "AccountFieldsThatAreSet": [ "PasswordCreateOnly" ], "JobId": "string", "SerializationType": [ "JSON" ], "StorageName": "http://example.com", "SupplierId": "string" }

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)

{ "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87", "LoginName": "string", "Password": "string", "Roles": [ {} ], "Status": 0 }

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.

{ "Code": "string", "IsActive": true }

Customers

Operations