Endpoints related to Transport Products.
List transport products
path Parameters
tenantIdTenant ID. Can be found in organisation settings
query Parameters
scopeHeaders
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.
List transport products › Responses
Transport products found. Returns products.
idtypenameIdentifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
measuresCustom 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.
enabledCreate a transport product
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 transport product › Request Body
typenameIdentifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
measuresCustom 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.
enabledCreate a transport product › Responses
Transport product was created.
idtypenameIdentifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
measuresCustom 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.
enabledGet a transport product
Get transport product either by ID or code if refType request parameter is supplied with value 'CODE'.
path Parameters
tenantIdTenant ID. Can be found in organisation settings
identifierProduct ID or Code
query Parameters
refTypeMust be supplied with value of CODE if identifier is a product code
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 transport product › Responses
Transport Product found. Returns product.
idtypenameIdentifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
measuresCustom 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.
enabled