COMMERCE CONNECT

Customer Service

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

openapi.json

openapi.yaml

Servers

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

Customers

Operations

Import companies

Request

Insert or update company information as well as attach or disconnect customers to the company.
Read more about the method here.

Headers

X-StormConnect-Headerstringrequired

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 both string or integer for application/json.

Body

requiredArray [

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.

]

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Customer/ImportCompanies \
  -H 'Content-Type: application/json' \
  -H 'X-StormConnect-Header: string' \
  -d '[
    {
      "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87",
      "AdditionalInfo": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "Code": "string",
      "Contacts": [
        {
          "Code": "string",
          "IsActive": true
        }
      ],
      "Customers": [
        {
          "Accounts": [
            {
              "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87",
              "LoginName": "string",
              "Password": "string",
              "Roles": [
                {}
              ],
              "Status": 0
            }
          ],
          "AdditionalInfo": [
            {
              "Code": "string",
              "Value": "string"
            }
          ],
          "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87",
          "CellPhoneNumber": "string",
          "Code": "string",
          "Companies": [
            {
              "Code": "string",
              "Id": 0,
              "IsPrimary": true,
              "Name": "string",
              "OrganizationNo": "string"
            }
          ],
          "CrmId": "string",
          "DeliveryAddresses": [
            {
              "AddressLine1": "string",
              "AddressLine2": "string",
              "CareOf": "string",
              "City": "string",
              "Code": "string",
              "CountryCode": "string",
              "Gln": "string",
              "IsPrimary": true,
              "IsValidated": true,
              "Region": "string",
              "ShippingPhoneNumber": "string",
              "ZipCode": "string"
            }
          ],
          "EmailAddress": "string",
          "FirstName": "string",
          "Flags": [
            {
              "Code": "string",
              "IsActive": true,
              "IsCreateOnly": true,
              "IsLimitedUpdate": true,
              "StopDate": "string"
            }
          ],
          "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,
          "IsCompanyListDelta": true,
          "LastName": "string",
          "MiddleName": "string",
          "PhoneNumber": "string",
          "PriceLists": [
            {
              "Code": "string",
              "IsExclusive": true
            }
          ],
          "SocialSecurityNumber": "string",
          "Title": "string",
          "Type": 0
        }
      ],
      "DeliveryAddresses": [
        {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "CareOf": "string",
          "City": "string",
          "Code": "string",
          "CountryCode": "string",
          "Gln": "string",
          "IsPrimary": true,
          "IsValidated": true,
          "Region": "string",
          "ShippingPhoneNumber": "string",
          "ZipCode": "string"
        }
      ],
      "DeliveryMethods": [
        {
          "Code": "string",
          "IsActive": true
        }
      ],
      "Discounts": [
        {
          "DiscountPercentage": 0,
          "PriceListTypeIdSeed": "string",
          "Type": "string",
          "ValueCode": "string"
        }
      ],
      "EmailAddress": "string",
      "Flags": [
        {
          "Code": "string",
          "IsActive": true,
          "IsCreateOnly": true,
          "IsLimitedUpdate": true,
          "StopDate": "string"
        }
      ],
      "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": [
        {
          "Code": "string",
          "InvoiceCaptureSettingsCode": "string",
          "IsActive": true
        }
      ],
      "PhoneNumber": "string",
      "PriceLists": [
        {
          "Code": "string",
          "IsExclusive": true
        }
      ],
      "VatNo": "string",
      "UseInvoiceAddressAsDeliveryAddress": true
    }
  ]'

Responses

Success

Body

StatusCodestring

Status of the job

Descriptionstring

Short message describing the job

JobIdstring(int32)

Norce Commerce's interal id created for this job. Refer to this for future requests.

ValidationSummaryobject(ValidationSummary)(ValidationSummary)

Validation data for accepted payload

Response

{
  "StatusCode": "string",
  "Description": "string",
  "JobId": "string",
  "ValidationSummary": {
    "NrOfItemsInTotal": 0,
    "NrOfValidationFailures": 0,
    "Messages": [ … ]
  }
}

Import customers

Request

Insert or update customer information, create accounts on the customer or create, attach or disconnect companies to the customer.
Read more about the method here.

Headers

x-stormconnect-headerstringrequired

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 both string or integer for application/json.

Body

requiredArray [

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

]

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Customer/ImportCustomers \
  -H 'Content-Type: application/json' \
  -H 'x-stormconnect-header: string' \
  -d '[
    {
      "Accounts": [
        {
          "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87",
          "LoginName": "string",
          "Password": "string",
          "Roles": [
            {
              "Code": "string",
              "IsActive": true
            }
          ],
          "Status": 0
        }
      ],
      "AdditionalInfo": [
        {
          "Code": "string",
          "Value": "string"
        }
      ],
      "ApplicationKey": "15d62d1f-3a4e-4111-845a-4db40bf08e87",
      "CellPhoneNumber": "string",
      "Code": "string",
      "Companies": [
        {
          "Code": "string",
          "Id": 0,
          "IsPrimary": true,
          "Name": "string",
          "OrganizationNo": "string"
        }
      ],
      "CrmId": "string",
      "DeliveryAddresses": [
        {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "CareOf": "string",
          "City": "string",
          "Code": "string",
          "CountryCode": "string",
          "Gln": "string",
          "IsPrimary": true,
          "IsValidated": true,
          "Region": "string",
          "ShippingPhoneNumber": "string",
          "ZipCode": "string"
        }
      ],
      "EmailAddress": "string",
      "FirstName": "string",
      "Flags": [
        {
          "Code": "string",
          "IsActive": true,
          "IsCreateOnly": true,
          "IsLimitedUpdate": true,
          "StopDate": "string"
        }
      ],
      "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,
      "IsCompanyListDelta": true,
      "LastName": "string",
      "MiddleName": "string",
      "PhoneNumber": "string",
      "PriceLists": [
        {
          "Code": "string",
          "IsExclusive": true
        }
      ],
      "SocialSecurityNumber": "string",
      "Title": "string",
      "Type": 0
    }
  ]'

Responses

Success

Body

StatusCodestring

Status of the job

Descriptionstring

Short message describing the job

JobIdstring(int32)

Norce Commerce's interal id created for this job. Refer to this for future requests.

ValidationSummaryobject(ValidationSummary)(ValidationSummary)

Validation data for accepted payload

Response

{
  "StatusCode": "string",
  "Description": "string",
  "JobId": "string",
  "ValidationSummary": {
    "NrOfItemsInTotal": 0,
    "NrOfValidationFailures": 0,
    "Messages": [ … ]
  }
}

Documentation Norce [Storm] Connect Customer Service (4.0)

Customers

Import companies

Request

Responses

Did the information on the page help you?

Import customers

Request

Responses

Did the information on the page help you?