mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-10 04:21:32 +00:00
13 lines
7.0 KiB
Markdown
13 lines
7.0 KiB
Markdown
# PickupBase
|
|
|
|
|
|
## 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. | | |