COMMERCE SERVICES
/
Customer Service
/
Address

Documentation CustomerService (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/customer/1.1/

Accounts

Operations

Address

Operations

Delete delivery address for company

Request

Deletes a delivery address for the specified Company.

Query
addressIdinteger(int32)required

The internal id of the Address to delete.

customerIdinteger(int32)required

The internal id of a Customer belonging to the Company.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/DeleteCompanyDeliveryAddress?addressId=0&customerId=0'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Delete delivery address for customer

Request

Deletes a delivery address for the specified Customer.

Query
addressIdinteger(int32)required

The internal id of the Address to delete.

customerIdinteger(int32)required

The internal id of the Customer to delete the Address for.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/DeleteCustomerDeliveryAddress?addressId=0&customerId=0'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Get external address for customer (v2)

Request

Gets a Customer's Address from an external source. Support for Klarna, ResursBank and Avarda exists and must be configured in Storm. Moreover an aggreement must be established with the PSP. Returns the customer with addresses populated according to customer type. Companies will have their addresses in Customer.DefaultCompany.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Body
required

A Customer with SSN and an optional InvoiceAddress must be passed in. If the search is for a Company, just pass the OrgNo in Customer.SSN. If no InvoiceAddress is passed the default Country.Code for the Application will be used.

Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/customer/1.1/GetExternalCustomerAddress2 \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "Key": "string",
    "Code": "string",
    "Email": "string",
    "SSN": "string",
    "FirstName": "string",
    "LastName": "string",
    "Phone": "string",
    "CellPhone": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "Account": {
      "Id": 0,
      "Key": "string",
      "LoginName": "string",
      "Name": "string",
      "Roles": [
        0
      ],
      "Authorizations": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ],
      "IsActive": true
    },
    "Companies": [
      {
        "Id": 0,
        "Key": "string",
        "Code": "string",
        "Name": "string",
        "OrgNo": "string",
        "Phone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "DeliveryAddresses": [
          {
            "Id": 0,
            "CareOf": "string",
            "Line1": "string",
            "Line2": "string",
            "Zip": "string",
            "City": "string",
            "CountryId": 0,
            "Country": "string",
            "Region": "string",
            "IsValidated": true,
            "GlobalLocationNo": "string",
            "ShippingPhoneNumber": "string"
          }
        ],
        "InvoiceAddress": {
          "Id": 0,
          "CareOf": "string",
          "Line1": "string",
          "Line2": "string",
          "Zip": "string",
          "City": "string",
          "CountryId": 0,
          "Country": "string",
          "Region": "string",
          "IsValidated": true,
          "GlobalLocationNo": "string",
          "ShippingPhoneNumber": "string"
        },
        "UseInvoiceAddressAsDeliveryAddress": true,
        "Info": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "ParentId": 0,
        "DeliveryMethodIds": [
          0
        ],
        "PaymentMethodIds": [
          0
        ],
        "Email": "string",
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "VatNo": "string"
      }
    ],
    "DeliveryAddresses": [
      {
        "Id": 0,
        "CareOf": "string",
        "Line1": "string",
        "Line2": "string",
        "Zip": "string",
        "City": "string",
        "CountryId": 0,
        "Country": "string",
        "Region": "string",
        "IsValidated": true,
        "GlobalLocationNo": "string",
        "ShippingPhoneNumber": "string"
      }
    ],
    "InvoiceAddress": {
      "Id": 0,
      "CareOf": "string",
      "Line1": "string",
      "Line2": "string",
      "Zip": "string",
      "City": "string",
      "CountryId": 0,
      "Country": "string",
      "Region": "string",
      "IsValidated": true,
      "GlobalLocationNo": "string",
      "ShippingPhoneNumber": "string"
    },
    "Flags": [
      {
        "Id": 0,
        "Name": "string",
        "Group": 0,
        "IsSelected": true
      }
    ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [
      {
        "Id": 0,
        "Value": "string",
        "Code": "string"
      }
    ],
    "PricelistIds": [
      0
    ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Insert delivery address for company

Request

Inserts a new delivery address for the specified Company.

Query
companyIdinteger(int32)required

The internal id of the Company to insert the Address for.

customerIdinteger(int32)required

The internal id of a Customer belonging to the Company.

updatedByinteger(int32)required

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Body
required

The Address to insert. The Address internal id should not have an id specified since it will be generated by Storm.

Idinteger or null(int32)

The internal Id of the Address. When creating a new Address leave this blank as Storm will generate the Id.

CareOfstring

The CareOf of the Address. MaxLength: 100.

Line1string

The first address line of the Address. MaxLength: 255.

Line2string

The second address line of the Address. MaxLength: 255.

Zipstring

The zip code of the Address. MaxLength: 50.

Citystring

The City of the Address. MaxLength: 50.

CountryIdinteger(int32)

The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.

Countrystring

The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50.

Regionstring

The Region of the Address. MaxLength: 50.

IsValidatedboolean

Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.

GlobalLocationNostring

The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50.

ShippingPhoneNumberstring

Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/InsertCompanyDeliveryAddress?companyId=0&customerId=0&updatedBy=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  }'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Insert delivery address for customer

Request

Inserts a new delivery address for the specified Customer.

Query
customerIdinteger(int32)required

The internal id of the Customer to insert the Address for.

updatedByinteger(int32)required

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Body
required

The Address to insert. The Address internal id should not have an id specified since it will be generated by Storm.

Idinteger or null(int32)

The internal Id of the Address. When creating a new Address leave this blank as Storm will generate the Id.

CareOfstring

The CareOf of the Address. MaxLength: 100.

Line1string

The first address line of the Address. MaxLength: 255.

Line2string

The second address line of the Address. MaxLength: 255.

Zipstring

The zip code of the Address. MaxLength: 50.

Citystring

The City of the Address. MaxLength: 50.

CountryIdinteger(int32)

The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.

Countrystring

The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50.

Regionstring

The Region of the Address. MaxLength: 50.

IsValidatedboolean

Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.

GlobalLocationNostring

The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50.

ShippingPhoneNumberstring

Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/InsertCustomerDeliveryAddress?customerId=0&updatedBy=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  }'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Update delivery address for company

Request

Updates a delivery address for the specified Company.

Query
customerIdinteger(int32)required

The internal id of a Customer belonging to the Company.

updatedByinteger(int32)required

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Body
required

The Address to update. The address internal id must have a valid id specified.

Idinteger or null(int32)

The internal Id of the Address. When creating a new Address leave this blank as Storm will generate the Id.

CareOfstring

The CareOf of the Address. MaxLength: 100.

Line1string

The first address line of the Address. MaxLength: 255.

Line2string

The second address line of the Address. MaxLength: 255.

Zipstring

The zip code of the Address. MaxLength: 50.

Citystring

The City of the Address. MaxLength: 50.

CountryIdinteger(int32)

The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.

Countrystring

The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50.

Regionstring

The Region of the Address. MaxLength: 50.

IsValidatedboolean

Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.

GlobalLocationNostring

The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50.

ShippingPhoneNumberstring

Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/UpdateCompanyDeliveryAddress?customerId=0&updatedBy=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  }'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Update delivery address for customer

Request

Updates a delivery address for the specified Customer.

Query
customerIdinteger(int32)required

The internal id of the Customer to update the Address for.

updatedByinteger(int32)required

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Body
required

The Address to update. The address must have a valid internal id specified.

Idinteger or null(int32)

The internal Id of the Address. When creating a new Address leave this blank as Storm will generate the Id.

CareOfstring

The CareOf of the Address. MaxLength: 100.

Line1string

The first address line of the Address. MaxLength: 255.

Line2string

The second address line of the Address. MaxLength: 255.

Zipstring

The zip code of the Address. MaxLength: 50.

Citystring

The City of the Address. MaxLength: 50.

CountryIdinteger(int32)

The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.

Countrystring

The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50.

Regionstring

The Region of the Address. MaxLength: 50.

IsValidatedboolean

Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.

GlobalLocationNostring

The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50.

ShippingPhoneNumberstring

Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/UpdateCustomerDeliveryAddress?customerId=0&updatedBy=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  }'

Responses

Success

Body
Idinteger or null(int32)

The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.

Keystring(guid)

The system wide unique Key of the Customer.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

Emailstring

The Email address of the Customer. MaxLength: 255.

SSNstring

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.

FirstNamestring

The FirstName of the Customer. MaxLength: 50.

LastNamestring

The LastName of the Customer. MaxLength: 50.

Phonestring

The PhoneNumber of the Customer. MaxLength: 50.

CellPhonestring

The CellPhone number of the Customer. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring

Used to tag a Customer with an incoming URL. MaxLength: 255.

Accountobject(Account)(Account)
CompaniesArray of objects(Company)(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject(Address)(Address)
FlagsArray of objects(Flag)(Flag)

A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.

UseInvoiceAddressAsDeliveryAddressboolean

Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

CrmIdstring

Used to save the Customers external id from a crm-system MaxLength: 50.

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Email": "string",
  "SSN": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "string",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true
  },
  "Companies": [
    { … }
  ],
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "Id": 0,
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "Zip": "string",
    "City": "string",
    "CountryId": 0,
    "Country": "string",
    "Region": "string",
    "IsValidated": true,
    "GlobalLocationNo": "string",
    "ShippingPhoneNumber": "string"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Companies

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations