Endpoints related to Consignments.
Create Consignment
Create a new consignment.
To perform this action, the API Client needs to have the “TMS Create Jobs” role.
path Parameters
tenantIdquery Parameters
applyDefaultsHeaders
Accept-VersionAll 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.
Create Consignment › Request Body
The customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Fields uniquely identifying Consignment
idBilling invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTagCreate Consignment › Responses
Created
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Fields uniquely identifying Consignment
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTagGet consignment
Get a single consignment by ID.
To perform this action, the API Client needs to have the “TMS View Jobs” role.
Note: Any API Client with the “TMS Create Jobs” role automatically has “TMS View Jobs” enabled.
Use Prefer: return=no-items to omit items from the response.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
consignmentIdThe consignment ID
Headers
Accept-VersionAll 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.
External-Meta-KeyThe External-Meta-Key header allows to specify the desired external meta key and only data associated with the specified key will be returned. If no key is specified or the key does not contain data, then externalMeta will not be returned.
Users with VIEW_ALL_EXTERNAL_META permission can specify * to return all available external meta. Data in externalMeta will be keyed by the external meta key.
Prefer| Value | Description |
|---|---|
| return=no-items | Omit items from the response. |
Get consignment › Responses
Consignment found. When Prefer: return=no-items is applied, items are omitted.
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Fields uniquely identifying Consignment
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTagQuote consignment charges
Get a quote for a consignment without persisting it.
To perform this action, the API Client needs to have the “TMS Create Jobs” role.
Returns 422 Unprocessable Entity with error messages when no matching rate is found or charges cannot be produced. Common messages include:
No matching rate found.— review from/to zones, service type, and effective dates on the rate.Warning, you may be undercharging your customers, please review the charges for this consignment.— a matching rate was found but produced no charges.You may be under-charging this consignment please check all items have been entered correctly.— a matching rate was found but not all items produced a charge.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
Headers
Accept-VersionAll 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.
Quote consignment charges › Request Body
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Fields uniquely identifying Consignment
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTagQuote consignment charges › Responses
Success. Charge description strings may include currency symbols formatted using the
consignment warehouse effective currency (see Money in common schemas).
Rate card used for the quote.
Rate matched for the quote.
List of produced charges.
Zone used for the collect address when quoting.
Zone used for the deliver address when quoting.
Service type used when matching the rate.
Search for consignments.
Search for consignments based on supported search criteria.
To perform this action, the API Client needs to have the “TMS View Jobs” role.
Note: Any API Client with the “TMS Create Jobs” role automatically has “TMS View Jobs” enabled.
Condition Fields
Supported JsonField Conditions
| Pointer | Description |
|---|---|
/references/customer | Customer reference |
/customer/id | Customer ID |
/details/runsheet/id | Run sheet ID |
/details/runsheet/date | Run sheet date (from the consignment) |
/user/id | Driver ID (from the consignment) |
/details/deliveryRun/id | Delivery run ID (from the consignment) |
/generatedFromTask/id | Sale order ID that generated this consignment |
/details/type | Consignment type (e.g. DELIVERY, PICKUP) |
ValueField aliases (for example reference, customerId, customerName, runSheetStatus, driverName) remain supported but are deprecated for fields that have a JsonField pointer. Prefer JsonField pointers that match consignment-owned response fields. Related-entity display fields such as customer name and run sheet status remain ValueField-only.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
Headers
Accept-VersionAll 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.
PreferWhen Prefer is applied, the Preference-Applied response header is returned.
| Value | Description |
|---|---|
| return=minimal | Switch the response into minimal representation (id only). |
Search for consignments. › Request Body
And and Or conditions must be accompanied with internal conditions property that provides all the fields level conditions that the wrapper must be applied to. Note: The FreeTextSearch condition cannot be combined with other fields level conditions.
Search for consignments. › Responses
Search results matching provided search criteria
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = array | |
| type = array |
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Fields uniquely identifying Consignment
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTag