A shipment in the Venddor API has various properties represented by fields. This document provides a comprehensive list of all supported fields, along with their descriptions, default values, and supported data types.
The following table lists all available fields for shipment objects:
| Field Name | Description | Default Value | Supported Values |
|---|---|---|---|
| carrier* | Carrier name | '' | Valid carrier name |
| order_id* | Order ID | — | Valid order ID |
| products* | Shipped products | — | JSON object with cart item ID as key and its quantity as value |
| shipping* | Shipping method name | 'Custom shipping method' | Valid shipping method name |
| shipping_id* | Shipping method ID | 1 | Valid shipping method ID |
| user_id* | Customer's user ID | — | Valid user ID |
| tracking_number | Tracking number | '' | string |
| comments | Comments about the shipment | '' | string |
| group_key | Supplier group key | Set automatically | Valid supplier group key |
| order_timestamp | Order creation timestamp | Set automatically | Valid timestamp in UNIX format |
{
"carrier": "FedEx",
"order_id": 78924,
"products": {
"467": 2,
"589": 1
},
"shipping": "Express Shipping",
"shipping_id": 3,
"user_id": 12453,
"tracking_number": "FDX783945201847",
"comments": "Customer requested delivery to back door"
}
Retrieves a list of all shipments.
Retrieves details of a specific shipment by its ID.
Creates a new shipment with the provided information.
Updates an existing shipment with the provided information.