Packagings

Packagings are advised for picklists and registered in shipments to gain insight in their usage.

Attributes

Name	Type	Required	Description
idpackaging	integer	generated	Unique identifier for the packaging
name	string	required	Name of the packaging
barcode	string	optional	Packaging barcode which can be scanned when creating a shipment
length	integer	optional	Length of the packaging in centimeters
width	integer	optional	Width of the packaging in centimeters
height	integer	optional	Height of the packaging in centimeters
use_in_auto_advice	boolean	optional	Indicates whether this package will be used in the automatic packaging advice
active	boolean	required	Indicates whether the packaging can still be used for shipments
created_at	datetime	required	Date and time when the packaging was created
updated_at	datetime	required	Date and time when the packaging was last updated

Get all packagings

Retrieve a list of all packagings. By default you will only get the active packagings. Provide the inactive parameter to get the inactive packagings.

GET https://example.com/api/v1/packagings

HTTP/1.1 200 OK [ { "idpackaging": 1, "name": "Envelope", "barcode": "3376627429184", "length": 20, "width": 14, "height": 2, "use_in_auto_advice": true, "active": true, "created_at": "2025-06-24 14:41:35", "updated_at": "2025-06-24 14:43:18" }, { "idpackaging": 2, "name": "Small Package", "barcode": "857825001442", "length": 30, "width": 20, "height": 20, "use_in_auto_advice": false, "active": true, "created_at": "2025-06-24 16:19:11", "updated_at": "2025-06-24 16:19:11" } ]

This endpoint uses pagination.

Filters

You can filter the packagings with the following parameter. Add this filter as a querystring parameter to the URL.

Attribute	Description	Example
inactive	Only provide this attribute to get the inactive packagings. Do not provide this attribute if you want to get the active packagings.	true

Get single packaging

Retrieve details of a specific packaging by its ID.

GET https://example.com/api/v1/packagings/{id}

HTTP/1.1 200 OK { "idpackaging": 2, "name": "Small Package", "barcode": "857825001442", "length": 30, "width": 20, "height": 20, "use_in_auto_advice": true, "active": true, "created_at": "2025-06-24 16:19:11", "updated_at": "2025-06-24 16:19:11" }

Create a packaging

Create a new packaging. Only the listed fields can be provided; other fields like idpackaging, created_at, etc., are automatically generated by the system. Note that length, width and height are required if one of them is provided.

Attributes

Name	Type	Required	Description
name	string	required	Name of the packaging
barcode	string	optional	Barcode of the packaging
length	integer	optional	Length of the packaging in centimeters
width	integer	optional	Width of the packaging in centimeters
height	integer	optional	Height of the packaging in centimeters
use_in_auto_advice	boolean	optional	Indicates whether this package can be used in the automatic packaging advice

POST https://example.com/api/v1/packagings

{ "name": "Shipping Container", "barcode": "5480962989264", "length": 590, "width": 235, "height": 239, "use_in_auto_advice": true, }

HTTP/1.1 201 Created { "idpackaging": 3, "name": "Shipping Container", "barcode": "5480962989264", "length": 590, "width": 235, "height": 239, "use_in_auto_advice": true, "active": true, "created_at": "2025-06-25 09:09:02", "updated_at": "2025-06-25 09:09:05" }

Update a packaging

Update an existing packaging. Only the listed fields can be modified.

Attributes

Name	Type	Required	Description
name	string	optional	Name of the packaging
barcode	string	optional	Barcode of the packaging
length	integer	optional	Length of the packaging in centimeters
width	integer	optional	Width of the packaging in centimeters
height	integer	optional	Height of the packaging in centimeters
use_in_auto_advice	boolean	optional	Indicates whether this package can be used in the automatic packaging advice
active	boolean	optional	Indicates whether the packaging can still be used for shipments

PUT https://example.com/api/v1/packagings/{id}

{ "name": "Shipping Container 40ft", "length": 1203, "active": false, "use_in_auto_advice": false, }

HTTP/1.1 200 OK { "idpackaging": 3, "name": "Shipping Container 40ft", "barcode": "5480962989264", "length": 1203, "width": 235, "height": 239, "use_in_auto_advice": false, "active": false, "created_at": "2025-06-25 09:09:02", "updated_at": "2025-06-25 09:15:26" }