Deliveries API
Search
K
Comment on page

Package

It is the object to be transported in a task.

Details

Property
Type
Description
Required
Constraint
id
string
Package identifier. If not entered, a random one will be added.
NO
-
name
string
Package name.
YES
-
size
string
Package size
YES
Can be X, XS, M, L, XL only.
qty
number
Number of packages in the order (not the number of products inside the package)
YES
weight
string
Unit weight * quantity in Kg
NO
price
string
Total price of packages
NO
properties
Array of Dynamic properties
Additional properties that may or may not be included in the package for better routing
NO

Example

{
"id": "013677|1",
"name": "NFs: Nao faturado - Peso Pacote Kg: 15,1700",
"size": "XL",
"qty": 3,
"weight": "15.17",
"price":"12.3"
"properties":[{
"id":19,
"name":"Volume",
"value":2
}]
}