Customers

Server

Endpoints related to Customers.

List customers

GET

https://api.cartoncloud.com

/tenants/{tenantId}/customers

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

CustomerSummary[]

CustomerSummary

id

UUID · uuid

name

string

Company name for the customer.

Create customer

POST

https://api.cartoncloud.com

/tenants/{tenantId}/customers

Create a new customer.

To perform this action, the API Client needs to have the “Add Customer” role. This can only be applied to internal API clients.

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

CustomerCreateRequest

name

string · required

Company name for the customer.

scope

string · enum

CUSTOMER for customer entities.

Enum values:

CUSTOMER

object

WarehouseReference[]

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

email

string

Email address for the customer.

telephone

string

Phone number for the customer.

Create customer › Responses

Created

Customer entity returned after create.

Customer

id

UUID · uuid · readOnly

scope

string · enum

CUSTOMER for customer entities.

Enum values:

CUSTOMER

object

WarehouseReference[]

Warehouses for which the customer is used.

name

string

Company name for the customer.

email

string

Email address for the customer.

telephone

string

Phone number for the customer.

enabled

boolean · readOnly

Whether the customer is enabled (defaults to true on create).

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 '{
  "scope": "CUSTOMER",
  "references": {
    "code": "TEST_CODE"
  },
  "warehouses": [],
  "name": "Test name",
  "email": "test-customer@cartoncloud.com.au",
  "telephone": "07777777"
}'

Example Request Body

{
  "scope": "CUSTOMER",
  "references": {
    "code": "TEST_CODE"
  },
  "warehouses": [],
  "name": "Test name",
  "email": "test-customer@cartoncloud.com.au",
  "telephone": "07777777"
}

json

Example Responses

{
  "enabled": true,
  "telephone": "7777777",
  "email": "test-customer@cartoncloud.com.au",
  "warehouses": [],
  "scope": "CUSTOMER",
  "name": "Test name",
  "references": {
    "code": "TEST_CODE"
  },
  "id": "d9ca778f-d09c-422b-a422-f39597b9ad5d"
}

json

application/json

Get customer

GET

https://api.cartoncloud.com

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

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

CustomerSummary

id

UUID · uuid

name

string

Company name for the customer.

Consignments Documents

List customers

GET

https://api.cartoncloud.com

/tenants/{tenantId}/customers

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

CustomerSummary[]

CustomerSummary

id

UUID · uuid

name

string

Company name for the customer.

Create customer

POST

https://api.cartoncloud.com

/tenants/{tenantId}/customers

Create a new customer.

To perform this action, the API Client needs to have the “Add Customer” role. This can only be applied to internal API clients.

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

CustomerCreateRequest

name

string · required

Company name for the customer.

scope

string · enum

CUSTOMER for customer entities.

Enum values:

CUSTOMER

object

WarehouseReference[]

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

email

string

Email address for the customer.

telephone

string

Phone number for the customer.

Create customer › Responses

Created

Customer entity returned after create.

Customer

id

UUID · uuid · readOnly

scope

string · enum

CUSTOMER for customer entities.

Enum values:

CUSTOMER

object

WarehouseReference[]

Warehouses for which the customer is used.

name

string

Company name for the customer.

email

string

Email address for the customer.

telephone

string

Phone number for the customer.

enabled

boolean · readOnly

Whether the customer is enabled (defaults to true on create).

Get customer

GET

https://api.cartoncloud.com

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

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

CustomerSummary

id

UUID · uuid

name

string

Company name for the customer.