Customers

Server

Endpoints related to Customers.

List customers

GET

https://api.cartoncloud.com

/tenants/{tenantId}/customers

required permission: VIEW_CUSTOMER

Get a list of available customers.

To perform this action, the API Client needs to have at least one of the following roles:

Add Customer
TMS Create Jobs
WMS Create Jobs

List customers › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

List customers › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

List customers › Responses

Success

Customer[]

Customer entity.

Customer

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

id

string · uuid · readOnly

object

scope

string · enum

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

CustomerWarehouseReference[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

Create customer

POST

https://api.cartoncloud.com

/tenants/{tenantId}/customers

required permission: ADD_CUSTOMER

Create a new customer.

To perform this action, the API Client needs to have the “Add Customer” role.

Create customer › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

Create customer › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

Create customer › Request Body

CustomerCreate

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

object

scope

string · enum

CUSTOMER for customer entities.

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

object[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

Create customer › Responses

Created

Customer entity.

Customer

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

id

string · uuid · readOnly

object

scope

string · enum

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

CustomerWarehouseReference[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

POST/tenants/{tenantId}/customers

curl https://api.cartoncloud.com/tenants/:tenantId/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "enabled": true,
  "name": "name",
  "references": {
    "code": "code"
  },
  "scope": "CUSTOMER",
  "telephone": "telephone",
  "warehouses": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}'

Example Request Body

{
  "email": "email",
  "enabled": true,
  "name": "name",
  "references": {
    "code": "code"
  },
  "scope": "CUSTOMER",
  "telephone": "telephone",
  "warehouses": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

json

Example Responses

{
  "email": "email",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "references": {
    "code": "code"
  },
  "scope": "CUSTOMER",
  "telephone": "telephone",
  "warehouses": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Melbourne"
    }
  ]
}

json

application/json

Get customer

GET

https://api.cartoncloud.com

/tenants/{tenantId}/customers/{customerId}

required permission: VIEW_CUSTOMER

Retrieves a previously created customer.

To perform this action, the API Client needs to have at least one of the following roles:

Add Customer
TMS Create Jobs
WMS Create Jobs

Get customer › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

customerId

UUID · uuid · required

UUID for the customer.

Example: 38756e85-d15c-45d9-84fd-1b3e50b73527

Get customer › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

Get customer › Responses

Success

Customer entity.

Customer

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

id

string · uuid · readOnly

object

scope

string · enum

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

CustomerWarehouseReference[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

Consignments Documents

List customers

GET

https://api.cartoncloud.com

/tenants/{tenantId}/customers

required permission: VIEW_CUSTOMER

Get a list of available customers.

To perform this action, the API Client needs to have at least one of the following roles:

Add Customer
TMS Create Jobs
WMS Create Jobs

List customers › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

List customers › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

List customers › Responses

Success

Customer[]

Customer entity.

Customer

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

id

string · uuid · readOnly

object

scope

string · enum

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

CustomerWarehouseReference[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

Create customer

POST

https://api.cartoncloud.com

/tenants/{tenantId}/customers

required permission: ADD_CUSTOMER

Create a new customer.

To perform this action, the API Client needs to have the “Add Customer” role.

Create customer › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

Create customer › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

Create customer › Request Body

CustomerCreate

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

object

scope

string · enum

CUSTOMER for customer entities.

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

object[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

Create customer › Responses

Created

Customer entity.

Customer

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

id

string · uuid · readOnly

object

scope

string · enum

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

CustomerWarehouseReference[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.

Get customer

GET

https://api.cartoncloud.com

/tenants/{tenantId}/customers/{customerId}

required permission: VIEW_CUSTOMER

Retrieves a previously created customer.

To perform this action, the API Client needs to have at least one of the following roles:

Add Customer
TMS Create Jobs
WMS Create Jobs

Get customer › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

customerId

UUID · uuid · required

UUID for the customer.

Example: 38756e85-d15c-45d9-84fd-1b3e50b73527

Get customer › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

Get customer › Responses

Success

Customer entity.

Customer

name

string · required

Company name for the customer.

email

string

Email address for the customer.

enabled

boolean

id

string · uuid · readOnly

object

scope

string · enum

Enum values:

CUSTOMER

telephone

string

Phone number for the customer.

CustomerWarehouseReference[]

Warehouses for which the customer is used. If not provided, assigned to the default warehouse.