# Shipments

### The Shipment Object

This section describes the different attributes available for a shipment.

| address\_to        | *string*   | Delivery address for shipment.                                                                                                                                                                                                                                                                                                      |
| ------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| address\_from      | *string*   | Pickup address for shipment.                                                                                                                                                                                                                                                                                                        |
| address\_return    | *string*   | Return address for shipment.                                                                                                                                                                                                                                                                                                        |
| carrier            | *string*   | Unique identifier for carrier executing shipment.                                                                                                                                                                                                                                                                                   |
| delivery\_date     | *string*   | Delivery date for shipment.                                                                                                                                                                                                                                                                                                         |
| delivery\_arranged | *string*   | Date delivery arranged for shipment.                                                                                                                                                                                                                                                                                                |
| events             | *array*    | Array of [status updates](https://docs.terminal.africa/tship/miscallaneous/shipment-event) on shipment provided by carrier.                                                                                                                                                                                                         |
| extras             | *object*   | Contains additional information related to shipment e.g. ***carrier\_tracking\_url***, ***reference***, ***shipping\_label**, **insurance, commercial\_invoice**, **courier\_instructions***, ***tracking\_number***, ***tracking\_url***. See [Shipment Extras](https://docs.terminal.africa/tship/miscallaneous/shipment-extras). |
| id                 | *string*   | Unique identifier for shipment.                                                                                                                                                                                                                                                                                                     |
| metadata           | *object*   | Provide additional information for a shipment.                                                                                                                                                                                                                                                                                      |
| parcel             | *string*   | Unique identifier of parcel to be shipped.                                                                                                                                                                                                                                                                                          |
| parcels            | *string*   | List of parcels to be shipped for a multi-parcel shipment.                                                                                                                                                                                                                                                                          |
| pickup\_date       | *date*     | Pickup date for shipment.                                                                                                                                                                                                                                                                                                           |
| shipment\_id       | *string*   | Unique reference for the shipment.                                                                                                                                                                                                                                                                                                  |
| shipment\_purpose  | *string*   | Purpose of shipment. Options are ***commercial***, ***personal***, ***sample***, ***return-after-repair***, ***return-for-repair.***                                                                                                                                                                                                |
| rate               | *string*   | Unique identifier of rate used in shipment.                                                                                                                                                                                                                                                                                         |
| status             | *enum*     | Status of shipment. Must be one of draft, cancelled, confirmed, pending, delivered or in-transit.                                                                                                                                                                                                                                   |
| created\_at        | *datetime* | Time shipment created.                                                                                                                                                                                                                                                                                                              |
| updated\_at        | *datetime* | Time shipment last updated.                                                                                                                                                                                                                                                                                                         |