mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-10 04:21:32 +00:00
24 lines
23 KiB
Markdown
24 lines
23 KiB
Markdown
# Pickup
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `carrier_account` | *str* | :heavy_check_mark: | The object ID of your USPS or DHL Express carrier account. <br/>You can retrieve this from your Rate requests or our <a href="#tag/Carrier-Accounts">carrier_accounts</a> endpoint. | adcfdddf8ec64b84ad22772bce3ea37a |
|
|
| `location` | [components.Location](../../models/components/location.md) | :heavy_check_mark: | Location where the parcel(s) will be picked up. | |
|
|
| `requested_end_time` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The latest that you requested your parcels to be available for pickup. <br/>Expressed in the timezone specified in the response. | |
|
|
| `requested_start_time` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The earliest that you requested your parcels to be ready for pickup. <br/>Expressed in the timezone specified in the response. | |
|
|
| `transactions` | List[*str*] | :heavy_check_mark: | The transaction(s) object ID(s) for the parcel(s) that need to be picked up. | [<br/>"adcfdddf8ec64b84ad22772bce3ea37a"<br/>] |
|
|
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you <br/>want to attach to the object. | |
|
|
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of Pickup creation. | |
|
|
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the given Pickup object. | |
|
|
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of last Pickup update. | |
|
|
| `confirmed_start_time` | *Optional[str]* | :heavy_minus_sign: | The earliest that your parcels will be ready for pickup, confirmed by the carrier. <br/>Expressed in the timezone specified in the response. | 2020-05-09T12:00:00Z |
|
|
| `confirmed_end_time` | *Optional[str]* | :heavy_minus_sign: | The latest that your parcels will be available for pickup, confirmed by the carrier. <br/>Expressed in the timezone specified in the response. | 2020-05-09T23:59:59.999Z |
|
|
| `cancel_by_time` | *Optional[str]* | :heavy_minus_sign: | The latest time to cancel a pickup. Expressed in the timezone specified in the response. <br/>To cancel a pickup, you will need to contact the carrier directly. <br/>The ability to cancel a pickup through Shippo may be released in future iterations. | 2020-05-09T08:00:00Z |
|
|
| `status` | [Optional[components.PickupStatus]](../../models/components/pickupstatus.md) | :heavy_minus_sign: | Indicates the status of the pickup. | CONFIRMED |
|
|
| `confirmation_code` | *Optional[str]* | :heavy_minus_sign: | Pickup's confirmation code returned by the carrier. <br/>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]* | :heavy_minus_sign: | The pickup time windows will be in the time zone specified here, not UTC. | US/Pacific |
|
|
| `messages` | List[*str*] | :heavy_minus_sign: | An array containing strings of any messages generated during validation. | [] |
|
|
| `is_test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | | |