CartonCloud
CartonCloud API
CartonCloud API

Delivery Runs

Endpoints related to Delivery Runs.

Get a list of Delivery Runs

GET
https://api.cartoncloud.com
/tenants/{tenantId}/delivery-runs
required permission: VIEW_DELIVERY_RUN

Returns a page of delivery runs for the tenant. Pagination totals are returned in response headers. Sort by a field such as name.

Get a list of Delivery Runs › path Parameters

tenantId
​string · uuid · required

Tenant ID. Can be found in organisation settings

Get a list of Delivery Runs › query Parameters

page
​integer

The page number to return results for

size
​integer

The number of elements per page. Default value may vary between endpoints

sort
​string

Field name and sort order separated by a comma. {dot separated field name},{asc/desc}

nullHandling
​string · enum
Enum values:
NULLS_FIRST
NULLS_LAST

Get a list of Delivery Runs › 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:
8

Get a list of Delivery Runs › Responses

Success

Identifies a delivery run by `id` and optional `name`. May include the associated warehouse.
DeliveryRunReference
id
​UUID · uuid
name
​string

Name of the delivery run

Example: BRISBANE CBD (DEFAULT)
​WarehouseReference

Identifies a warehouse. When both id and name are supplied, id is used first. name must match the warehouse name in CartonCloud exactly.

​CarrierReference

Carrier Reference

DefinitionsDocuments