Endpoints related to Inbound Orders.
Create a new Inbound Order
Create a new inbound order (purchase order).
To perform this action, the API Client needs to have the “WMS Create Job” role.
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.
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.
IncludeComma-separated list of additional fields to include in the response.
Create a new Inbound Order › Request Body
Fields uniquely identifying Inbound order
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
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.
measuresstatusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Details specific for the Inbound Order object
List of Inbound Item objects
Create a new Inbound Order › Responses
Order successfully 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.
typeFields uniquely identifying Inbound order
Custom 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.
Only returned when the Include request header contains measures.
statusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Map of timestamp entries for various lifecycle events
versionExternal Metadata by a specific External meta key
Details specific for the Inbound Order object
List of Inbound Item objects
Search Inbound Orders
Search for previously created inbound orders (purchase orders).
To perform this action, the API Client needs to have the “WMS Create Job” role.
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.
IncludeComma-separated list of additional fields to include in the response.
PreferWhen Prefer is applied, the Preference-Applied response header is returned.
| Value | Description |
|---|---|
| return=minimal | Switch the response into minimal representation (id only). |
Search Inbound Orders › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="AndCondition" · requires: conditions | |
| type = object · type="OrCondition" · requires: conditions |
typeSearch Inbound Orders › Responses
Success
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.
typeFields uniquely identifying Inbound order
Custom 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.
Only returned when the Include request header contains measures.
statusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Map of timestamp entries for various lifecycle events
versionExternal Metadata by a specific External meta key
Details specific for the Inbound Order object
List of Inbound Item objects
View Inbound Order
Retrieves a previously created inbound order (purchase order).
To perform this action, the API Client needs to have the “WMS Create Job” role.
Response shape matches Create Inbound Order. Use Prefer: return=no-items to omit items. Use the Include header to add measures.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
orderIdInbound Order 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.
IncludeComma-separated list of additional fields to include in the response.
PreferWhen Prefer is applied, the Preference-Applied response header is returned.
| Value | Description |
|---|---|
| return=no-items | Omit items from the response. |
View Inbound Order › Responses
Success. Response body depends on the Prefer request header: - Prefer: return=no-items → InboundOrder_NoItems - Prefer header omitted → InboundOrder_Default
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
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.
typeFields uniquely identifying Inbound order
Custom 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.
Only returned when the Include request header contains measures.
statusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Map of timestamp entries for various lifecycle events
versionExternal Metadata by a specific External meta key
Details specific for the Inbound Order object
List of Inbound Item objects