Skip to content

Latest commit

 

History

History
48 lines (43 loc) · 7.9 KB

pickupbase.md

File metadata and controls

48 lines (43 loc) · 7.9 KB
Raw

PickupBase

Example Usage

import { PickupBase } from "shippo/models/components";

let value: PickupBase = {
  carrierAccount: "adcfdddf8ec64b84ad22772bce3ea37a",
  location: {
    address: {
      name: "Shwan Ippotle",
      company: "Shippo",
      street1: "215 Clayton St.",
      street3: "",
      streetNo: "",
      city: "San Francisco",
      state: "CA",
      zip: "94117",
      country: "US",
      phone: "+1 555 341 9393",
      email: "[email protected]",
      isResidential: true,
      metadata: "Customer ID 123456",
      validate: true,
    },
    buildingLocationType: "Front Door",
    buildingType: "apartment",
    instructions: "Behind screen door",
  },
  requestedEndTime: new Date("2024-09-09T14:45:41.967Z"),
  requestedStartTime: new Date("2023-02-07T20:20:50.747Z"),
  transactions: [
    "adcfdddf8ec64b84ad22772bce3ea37a",
  ],
};

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 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 Date ✔️ The latest that you requested your parcels to be available for pickup.
Expressed in the timezone specified in the response.
requestedStartTime Date ✔️ The earliest that you requested your parcels to be ready for pickup.
Expressed in the timezone specified in the response.
transactions string[] ✔️ The transaction(s) object ID(s) for the parcel(s) that need to be picked up. [
"adcfdddf8ec64b84ad22772bce3ea37a"
]