Skip to content
COMMERCE SERVICES
/
Customer Service
/
Companies
/
Insert customer in company (v2)

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

Companies

Operations

Inactivate company

Request

Inactivates a Company. Inactivated Companies cannot be activated again.

Query
companyIdinteger(int32)required

The internal Id of the Company to inactivate.

inactivatedByinteger(int32)required

Account internal id of current user. Do not use default value.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/InactivateCompany?companyId=0&inactivatedBy=0'

Responses

Success

Body

Insert customer in company (v2)

Request

Inserts a customer into a company.

Query
passwordstring

An application generated password used if an Account is created. If none is supplied the password will be generated. Generated passwords are 8 random alpha numeric characters mixed lower and upper case. The password is not stored in clear text in Storm. Only a hash value of the password gets stored.

companyIdinteger(int32)required

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

updatedBystringrequired

Account internal id of current user. Pass 1 for the default account.

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 Customer to add to the Company. If the Customer already exists, it will get an Account, if missing, and the Company will be added to the list of Companies for the Customer. Then the Customer will be updated. If the Customer does not exist, it will be created. See UpdateCustomer and CreateCustomer for details. Note that Customer.Companies will be ignored so there's no meaning in passing in Companies there.

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/InsertCompanyCustomer2?companyId=0&updatedBy=string' \
  -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
Array [
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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  }
]

Insert delivery method for company

Request

Inserts a DeliveryMethod for the specified Company.

Query
methodIdinteger(int32)required

The internal id of the DeliveryMethod to insert.

companyIdinteger(int32)required

The internal id of the Company for which the DeliveryMethod gets inserted.

createdBystring

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.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/InsertCompanyDeliveryMethod?methodId=0&companyId=0'

Responses

Success

Body
Idinteger or null(int32)

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

Keystring(guid)

The system wide unique Key of the Company.

Codestring

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

Namestring

The Name of the Company. MaxLength: 100.

OrgNostring

The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.

Phonestring

The Phone number of the Company. MaxLength: 50.

ReferIdinteger or null(int32)

Used to tag a Company with some external id.

ReferUrlstring

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

DeliveryAddressesArray of objects(Address)(Address)

A list of delivery Addresses for the Company. 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)
UseInvoiceAddressAsDeliveryAddressboolean

Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.

PricelistIdsArray of integers(int32)

Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.

ParentIdinteger or null(int32)

Points to an optional parent company. Used when companies are connected some how.

DeliveryMethodIdsArray of integers(int32)

Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.

PaymentMethodIdsArray of integers(int32)

Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.

Emailstring

The Email address of the Company. MaxLength: 255.

FlagsArray of objects(Flag)(Flag)

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

VatNostring

This is the VAT registration number for the company. MaxLength: 50.

Response
{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "Name": "string",
  "OrgNo": "string",
  "Phone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "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"
  },
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "ParentId": 0,
  "DeliveryMethodIds": [
    0
  ],
  "PaymentMethodIds": [
    0
  ],
  "Email": "string",
  "Flags": [
    { … }
  ],
  "VatNo": "string"
}

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations