> For the complete documentation index, see [llms.txt](https://docs.terminal.africa/tship/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terminal.africa/tship/shipment.md).

# 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](/tship/miscallaneous/shipment-event.md) 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](/tship/miscallaneous/shipment-extras.md). |
| 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.                                                                                                                                                                                                                                                                                |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.terminal.africa/tship/shipment.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.