Customers

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

A customer is not an addressee of an order.

The customer model

Properties

Name
id
Type
string
Readonly
readonly
Description
Name
code
Type
string
Description
Name
name
Type
string
Description
Name
created_at
Type
datetime
Readonly
readonly
Description
Name
modified_at
Type
datetime
Readonly
readonly
Description

GET/wms/customers/

List all customers

Retrieves a collection of customers

Optional attributes

Name
limit
Type
integer
Description
Limits the amount of results.
Name
page
Type
integer
Description
Only works in combination with the limit attribute.
Name
from
Type
date
Description
Accepts date format %Y-%m-%d. IE: 2022-10-22
Name
to
Type
date
Description
Accepts date format %Y-%m-%d. IE: 2022-10-22
Name
direction
Type
string
Description
Sort direction. Options: asc | desc
Default
Default: asc
Name
sort
Type
string
Description
You can sort on the following fields:
- createdAt
- name
Default
Default: name

Request

GET

/wms/customers/

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

Response

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

GET/wms/customers/:id/

Retrieve a customer

Retrieve a single customer.

Request

GET

/wms/customers/:id/

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

Response

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