Developer documentation

Customers

Use the Customers API to list and retrieve customers.

A customer is a registered partner of eWarehousing. Customers hold information such as orders, stock and inbounds.

**Customers in the API**

In the API, a "customer" is the WMS customer/account that owns stock and orders.

Response models

These response models describe the objects returned by this resource.

The customer model

Core customer properties returned by the API.

Field	Description
`id` stringOptional	Read-only unique identifier.
`code` stringOptional	Customer code.
`name` stringOptional	Customer name.
`created_at` datetimeOptional	Read-only creation timestamp.
`updated_at` datetimeOptional	Read-only last update timestamp.

List all customers

GET/wms/customers/

Retrieves a collection of customers

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

Field	Description
`limit` integerOptional	Limit the number of results. Default is 50.
`page` integerOptional	The page number to retrieve.
`direction` stringOptional	Sort direction. Options: `asc` or `desc`. Default is `asc`.
`sort` stringOptional	Sort field. Options: `createdAt` or `name`. Default is `name`.

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/customers/

Response exampleJSON

[
  {
    "id": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "code": "EWHS",
    "name": "eWarehousing Solutions"
  },
  {
    "id": "f190900a-ebfd-4262-9dd6-05ddd61721b0",
    "code": "ACM",
    "name": "Acme"
  }
]

Retrieve a customer

GET/wms/customers/:id/

Retrieve a single customer.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/customers/e710389a-5505-49d4-9b99-8314f3543427

Response exampleJSON

{
  "id": "f190900a-ebfd-4262-9dd6-05ddd61721b0",
  "code": "ACM",
  "name": "Acme"
}