| Field | Type | Required | Description | Example |
|---|---|---|---|---|
carrier_account |
str | ✔️ | The object ID of your USPS or DHL Express carrier account. You can retrieve this from your Rate requests or our Carrier Accounts endpoint. |
adcfdddf8ec64b84ad22772bce3ea37a |
location |
components.Location | ✔️ | Location where the parcel(s) will be picked up. | |
requested_end_time |
date | ✔️ | The latest that you requested your parcels to be available for pickup. Expressed in the timezone specified in the response. |
|
requested_start_time |
date | ✔️ | The earliest that you requested your parcels to be ready for pickup. Expressed in the timezone specified in the response. |
|
transactions |
List[str] | ✔️ | The transaction(s) object ID(s) for the parcel(s) that need to be picked up. | [ "adcfdddf8ec64b84ad22772bce3ea37a" ] |
metadata |
Optional[str] | ➖ | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
|
object_created |
date | ➖ | Date and time of Pickup creation. | |
object_id |
Optional[str] | ➖ | Unique identifier of the given Pickup object. | |
object_updated |
date | ➖ | Date and time of last Pickup update. | |
confirmed_start_time |
Optional[str] | ➖ | The earliest that your parcels will be ready for pickup, confirmed by the carrier. Expressed in the timezone specified in the response. |
2020-05-09T12:00:00Z |
confirmed_end_time |
Optional[str] | ➖ | The latest that your parcels will be available for pickup, confirmed by the carrier. Expressed in the timezone specified in the response. |
2020-05-09T23:59:59.999Z |
cancel_by_time |
Optional[str] | ➖ | The latest time to cancel a pickup. Expressed in the timezone specified in the response. To cancel a pickup, you will need to contact the carrier directly. The ability to cancel a pickup through Shippo may be released in future iterations. |
2020-05-09T08:00:00Z |
status |
Optional[components.PickupStatus] | ➖ | Indicates the status of the pickup. | CONFIRMED |
confirmation_code |
Optional[str] | ➖ | Pickup's confirmation code returned by the carrier. To edit or cancel a pickup, you will need to contact USPS or DHL Express directly and provide your confirmation_code. |
WTC310058750 |
timezone |
Optional[str] | ➖ | The pickup time windows will be in the time zone specified here, not UTC. | US/Pacific |
messages |
List[str] | ➖ | An array containing strings of any messages generated during validation. | [] |
is_test |
Optional[bool] | ➖ | Indicates whether the object has been created in test mode. |