Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 7.04 KB

PickupBase.md

File metadata and controls

13 lines (10 loc) · 7.04 KB

PickupBase

Fields

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 Location ✔️ Location where the parcel(s) will be picked up.
metadata Optional A string of up to 100 characters that can be filled with any additional information you
want to attach to the object.
requestedEndTime OffsetDateTime ✔️ The latest that you requested your parcels to be available for pickup.
Expressed in the timezone specified in the response.
requestedStartTime OffsetDateTime ✔️ The earliest that you requested your parcels to be ready for pickup.
Expressed in the timezone specified in the response.
transactions List<String> ✔️ The transaction(s) object ID(s) for the parcel(s) that need to be picked up. [
"adcfdddf8ec64b84ad22772bce3ea37a"
]