| Field | Type | Required | Description | Example |
|---|---|---|---|---|
carrierAccount |
string | ✔️ | 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 |
\Shippo\API\Models\Components\Location | ✔️ | Location where the parcel(s) will be picked up. | |
metadata |
?string | ➖ | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
|
requestedEndTime |
\DateTime | ✔️ | The latest that you requested your parcels to be available for pickup. Expressed in the timezone specified in the response. |
|
requestedStartTime |
\DateTime | ✔️ | The earliest that you requested your parcels to be ready for pickup. Expressed in the timezone specified in the response. |
|
transactions |
array<string> | ✔️ | The transaction(s) object ID(s) for the parcel(s) that need to be picked up. | [ "adcfdddf8ec64b84ad22772bce3ea37a" ] |