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.
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.
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 |
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 |
