# The easypost pickup object

An easypost pickup object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/easypost_pickups` endpoint.

## Fields

| Field                                  | Type       | Description                                                                                                                                                                                         |
| -------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                               | `string`   | `easypost_pickups`                                                                                                                                                                                  |
| **id**                                 | `string`   | The easypost pickup unique identifier                                                                                                                                                               |
| links.**self**                         | `string`   | The easypost pickup endpoint URL                                                                                                                                                                    |
| attributes.**status**                  | `string`   | The pick up status.                                                                                                                                                                                 |
| attributes.**internal\_id**            | `string`   | The pick up service internal ID.                                                                                                                                                                    |
| attributes.**created\_at**             | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**             | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**               | `string`   | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin**       | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**                | `object`   | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| attributes.**selected\_rate\_id**      | `string`   | The selected purchase rate from the available pick up rates.                                                                                                                                        |
| attributes.**rates**                   | `array`    | The available pick up rates.                                                                                                                                                                        |
| attributes.**instructions**            | `string`   | Additional text to help the driver successfully obtain the package, automatically enriched with parcels and package informations.                                                                   |
| attributes.**min\_datetime**           | `datetime` | The earliest time at which the package is available to pick up, must be larger than 2 hours from creation time.                                                                                     |
| attributes.**max\_datetime**           | `datetime` | The latest time at which the package is available to pick up, must be smaller than 24 hours from creation time.                                                                                     |
| attributes.**\_purchase**              | `boolean`  | Send this attribute if you want to purchase this pick up with the selected rate.                                                                                                                    |
| attributes.**purchase\_started\_at**   | `datetime` | Time at which the purchasing of the pick up rate started.                                                                                                                                           |
| attributes.**purchase\_completed\_at** | `datetime` | Time at which the purchasing of the pick up rate completed.                                                                                                                                         |
| relationships.**shipment**             | `object`   | The associated shipment.                                                                                                                                                                            |
| relationships.**parcels**              | `array`    | The associated parcels.                                                                                                                                                                             |
| relationships.**events**               | `array`    | The associated events.                                                                                                                                                                              |
| relationships.**event\_stores**        | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                          | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |