Skip to content

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

Schemas

Address

Company or 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

{ "AddressLine1": "string", "AddressLine2": "string", "CareOf": "string", "City": "string", "Code": "string", "CountryCode": "string", "Gln": "string", "IsPrimary": true, "IsValidated": true, "Region": "string", "ShippingPhoneNumber": "string", "ZipCode": "string" }

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.

{ "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87", "AdditionalInfo": [ {} ], "Code": "string", "Contacts": [ {} ], "Customers": [ {} ], "DeliveryAddresses": [ {} ], "DeliveryMethods": [ {} ], "Discounts": [ {} ], "EmailAddress": "string", "Flags": [ {} ], "Id": 0, "InvoiceAddress": { "AddressLine1": "string", "AddressLine2": "string", "CareOf": "string", "City": "string", "Code": "string", "CountryCode": "string", "Gln": "string", "IsPrimary": true, "IsValidated": true, "Region": "string", "ShippingPhoneNumber": "string", "ZipCode": "string" }, "IsActive": true, "IsCustomerListDelta": true, "LogoImage": { "ExternalCode": "string", "FileTypeName": "string", "Url": "http://example.com", "Filename": "string", "LastModified": "string" }, "Name": "string", "OrganizationNo": "string", "ParentCompanyCode": "string", "PaymentMethods": [ {} ], "PhoneNumber": "string", "PriceLists": [ {} ], "VatNo": "string", "UseInvoiceAddressAsDeliveryAddress": true }

CompanyIdentifier

Company identifier to connect customers to companies

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.

{ "Code": "string", "Id": 0, "IsPrimary": true, "Name": "string", "OrganizationNo": "string" }

Customers

Operations