Endpoints related to Warehouse Products.
Create a warehouse product
details.countryOfOrigin and details.harmonizedSystemCode require Accept-Version 7 or higher on this endpoint.
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.
Create a warehouse product › Request Body
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
All unit of measures defined for warehouse product
descriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
Array of warehouse product notifications
Create a warehouse product › Responses
Warehouse product was created.
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
iddescriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
timestampsMap of timestamp entries for the Warehouse Product lifecycle events
Search Warehouse Products
Search for warehouse products based on search criteria.
Condition Fields
Supported JsonField Conditions
| Pointer | Description |
|---|---|
/name | Product name |
/references/code | Product code |
/customer/id | Customer ID |
/customer/name | Customer name |
/details/active | Whether the product is active |
/timestamps/created/time | Product creation timestamp (ISO 8601 format) |
/timestamps/modified/time | Product last modification timestamp (ISO 8601 format) |
path Parameters
tenantIdTenant ID. Can be found in organisation settings
query Parameters
pageThe page number to return results for
sizeThe number of elements per page. Default value may vary between endpoints
sortField name and sort order separated by a comma. {dot separated field name},{asc/desc}
nullHandlingHeaders
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.
Search Warehouse Products › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="AndCondition" · requires: conditions | |
| type = object · type="OrCondition" · requires: conditions |
typeSearch Warehouse Products › Responses
Success
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
iddescriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
timestampsMap of timestamp entries for the Warehouse Product lifecycle events
Get a warehouse product
Get warehouse product by ID
path Parameters
tenantIdTenant ID. Can be found in organisation settings
warehouseProductIdWarehouse Product 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.
Get a warehouse product › Responses
Warehouse Product found. Returns product.
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
iddescriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
timestampsMap of timestamp entries for the Warehouse Product lifecycle events
Update Product (PUT)
Updates a previously created product.
The endpoint has been deprecated since API version 7. Consider using PATCH for updating an existing product instead.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
warehouseProductIdWarehouse Product 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.
Update Product (PUT) › Request Body
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
All unit of measures defined for warehouse product
descriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
Array of warehouse product notifications
Update Product (PUT) › Responses
Product updated successfully
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
iddescriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
timestampsMap of timestamp entries for the Warehouse Product lifecycle events
Partial Product Update (PATCH)
Partial Product Update (PATCH)
⚠️ Current Limitations:
- In case of the defaultUnitOfMeasure update conversion rate 1:1 will be applied
- Some paths values cannot be changed (ex. /id, /customer/*)
- For certain paths, the remove operation resets the value to its default (e.g., /details/stockSelection).
- Partial array updates (e.g., /notifications/0) are not supported. To modify an array, you can either replace the entire array or append a new element using the - symbol (e.g., /notifications/-).
path Parameters
tenantIdTenant ID. Can be found in organisation settings
warehouseProductIdWarehouse Product 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.
Partial Product Update (PATCH) › Request Body
List of patch operations following the JSON Patch specification. See RFC 6902 - JSON Patch for the official documentation. (add, replace, remove operations are supported)
Partial Product Update (PATCH) › Responses
Product updated successfully
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
iddescriptionProduct description
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.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
timestampsMap of timestamp entries for the Warehouse Product lifecycle events