Companies

Companies can be managed in Order Book and used as clients for Transport Requests. This allows you to target Conditionals to Orders contained within Transport Requests for select clients.

Find out more

Operations

Get a Company with specified business id

Request

Retrieve a single Company by its business id.

Security

clientCredentials

Path

business_idstring^[a-zA-Z0-9.~\-_]{1,512}$required

The business identifier of an entity instance

Payload

// No request payload

Responses

Headers

ETagstring

weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity

Bodyapplication/json

business_idstring^[a-zA-Z0-9.~\-_]+$

A unique reference ID

Example:"624ec196-4c5c-4fb4-bb43-9ffd8a6b8844"

namestring

The name of this Company

Example:"a name"

Response

{
  "business_id": "624ec196-4c5c-4fb4-bb43-9ffd8a6b8844",
  "name": "a name"
}