COMMERCE SERVICES
/
Customer Service
/
Companies
/
List companies by organization number

Norce Commerce Customer v1.1 service (1.1)

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

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Accounts

Operations

Address

Contains endpoints for managing addresses on Customer and Company objects.

Operations

Companies

Contains endpoints for managing Company data and related information.

Operations

List companies by parent

Request

Lists Companies by parent company.

Query
parentIdinteger(int32)

The internal Id of the parent Company to fetch children for.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/ListCompaniesByParent \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Company.

Codestring or null[ 0 .. 50 ] characters

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

Namestring or null[ 0 .. 100 ] characters

The Name of the Company. MaxLength: 100

OrgNostring or null[ 0 .. 50 ] characters

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 or null[ 0 .. 50 ] characters

The Phone number of the Company. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Company with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

DeliveryAddressesArray of objects or null(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 or null

Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed

UseInvoiceAddressAsDeliveryAddressboolean or null

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 or null(IdValue)

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

PricelistIdsArray of integers or null(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 or null(int32)

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

PaymentMethodIdsArray of integers or null(int32)

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Company. MaxLength: 255

FlagsArray of objects or null(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 or null[ 0 .. 50 ] characters

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

]
Response
application/json
[
  {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "Code": "string",
    "Name": "string",
    "OrgNo": "string",
    "Phone": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "ParentId": 0,
    "DeliveryMethodIds": [ … ],
    "PaymentMethodIds": [ … ],
    "Email": "string",
    "Flags": [ … ],
    "VatNo": "string"
  }
]

List companies by organization number

Request

Lists Companies by organization number. Note that OrgNo need not be unique within storm, only the combination of OrgNo and Name must be unique.

Query
orgNostring

The organization number of the Companies to fetch. All non-numerical characters will be removed in the string before the search.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/ListCompaniesByOrgNo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Company.

Codestring or null[ 0 .. 50 ] characters

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

Namestring or null[ 0 .. 100 ] characters

The Name of the Company. MaxLength: 100

OrgNostring or null[ 0 .. 50 ] characters

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 or null[ 0 .. 50 ] characters

The Phone number of the Company. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Company with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

DeliveryAddressesArray of objects or null(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 or null

Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed

UseInvoiceAddressAsDeliveryAddressboolean or null

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 or null(IdValue)

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

PricelistIdsArray of integers or null(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 or null(int32)

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

PaymentMethodIdsArray of integers or null(int32)

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Company. MaxLength: 255

FlagsArray of objects or null(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 or null[ 0 .. 50 ] characters

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

]
Response
application/json
[
  {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "Code": "string",
    "Name": "string",
    "OrgNo": "string",
    "Phone": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "ParentId": 0,
    "DeliveryMethodIds": [ … ],
    "PaymentMethodIds": [ … ],
    "Email": "string",
    "Flags": [ … ],
    "VatNo": "string"
  }
]

Get company by organization number

Request

Gets a Company by org no. Since Companies are not unique on OrgNo only just the last Company with the specified OrgNo will be returned. Returns null if the Company does not exist.

Query
orgNostring

The organization number of the Company to fetch. All non-numerical characters will be removed in the string before the search.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/GetCompanyByOrgNo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Company.

Codestring or null[ 0 .. 50 ] characters

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

Namestring or null[ 0 .. 100 ] characters

The Name of the Company. MaxLength: 100

OrgNostring or null[ 0 .. 50 ] characters

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 or null[ 0 .. 50 ] characters

The Phone number of the Company. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Company with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

DeliveryAddressesArray of objects or null(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 or null

Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed

UseInvoiceAddressAsDeliveryAddressboolean or null

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 or null(IdValue)

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

PricelistIdsArray of integers or null(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 or null(int32)

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

PaymentMethodIdsArray of integers or null(int32)

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Company. MaxLength: 255

FlagsArray of objects or null(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 or null[ 0 .. 50 ] characters

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

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "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",
    "Code": "string"
  },
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "ParentId": 0,
  "DeliveryMethodIds": [
    0
  ],
  "PaymentMethodIds": [
    0
  ],
  "Email": "string",
  "Flags": [
    { … }
  ],
  "VatNo": "string"
}

Customers

Contains endpoints for managing Customer data and related information.

Operations

Flags

Contains endpoints for viewing Customer and Company flags.

Operations

InfoTypes

Contains endpoints for viewing metadata about Customer and Company extended fields.

Operations

PriceLists

Contains endpoints for managing company connected price lists.

Operations

Schemas