Skip to content
COMMERCE SERVICES
/
Customer Service
/
Companies

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

Delete customer from company

Request

Deletes a Customer from the Company. It does not delete the Customer from Storm but just removes the relation between Company and Customer.

Query
companyIdinteger(int32)required

The internal id of the Company for which the Customer is removed.

customerIdinteger(int32)required

The internal id of the Customer to remove from the Company.

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/DeleteCompanyCustomer?companyId=0&customerId=0'

Responses

Success

Body

Delete delivery method for company

Request

Deletes a DeliveryMethod for the specified Company.

Query
methodIdinteger(int32)required

The internal id of the DeliveryMethod to delete.

companyIdinteger(int32)required

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

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/DeleteCompanyDeliveryMethod?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"
}

Delete company discount

Request

Deletes the discount.

Query
companyIdinteger(int32)required

The company internal id for the discount.

Body
required

The discount to delete. See CompanyDiscount entity for details.

TypeIdinteger(int32)

The TypeId defines the rule for how Value is interpreted. 1 = Category discount, 2 = DiscountCode on product. Cannot be changed.

Valuestring

The value to check for on products. If TypeID = 1 then discounts are valid for all products belonging to Category with Category.Code = Value. If TypeId = 2 then the product's discount code is checked. Cannot be changed. MaxLength: 50.

Discountnumber(decimal)

The actual discount percentage. Ex: 15.00 equals 15% discount.

PriceListTypeSeedstring

An optional comma-separated list of priceList type-ids for which the discount is valid. MaxLength: 50.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/DeleteCompanyDiscount?companyId=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "TypeId": 0,
    "Value": "string",
    "Discount": 0,
    "PriceListTypeSeed": "string"
  }'

Responses

Success

Body

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations