UPS Pickup Virtual Sandbox

Schedule, manage, and cancel package pickups through the UPS Pickup API.

The UPS Pickup API allows developers to programmatically schedule package pickups, retrieve details of previously scheduled pickups, and manage cancellations. It supports various pickup types and service center location lookups to streamline logistics workflows.

Use this hosted sandbox to simulate UPS Pickup APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate pickup request payloads, handle service center location responses, test cancellation workflows, and verify error handling for invalid pickup dates or location codes before integrating with UPS production systems.

UPS Pickup virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS Pickup responses instantly.

`https://ups-pickup.mock.beeceptor.com`

Pickup(8 operations)

POST

/shipments/{version}/pickup/{pickuptype}

Using the POST operation of the pickuptype endpoint within the Pickup API, users can request rates for UPS on-demand package pickup. The endpoint allows users to specify pickup details like address, date/time, and other options, and returns pricing information for booking that pickup.

Header Name	Example
`transId`	`"nisi reprehenderit"`
`transactionSrc`	`"exercitation do"`

Request Payload

{
  "PickupRateRequest": {
    "PickupAddress": {
      "AddressLine": "315 Saddle Bridge Drive",
      "City": "Allendale",
      "StateProvince": "NJ",
      "PostalCode": "07401",
      "CountryCode": "US",
      "ResidentialIndicator": "Y"
    },
    "AlternateAddressIndicator": "N",
    "ServiceDateOption": "02",
    "PickupDateInfo": {
      "CloseTime": "2000",
      "ReadyTime": "900",
      "PickupDate": "20160405"
    }
  }
}

Response Payload

{
  "PickupRateResponse": {
    "RateResult": {
      "ChargeDetail": [
        {
          "ChargeAmount": "67.79+67",
          "ChargeCode": "A",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "61.99 61",
          "TaxAmount": "4.66@4.6"
        },
        {
          "ChargeAmount": "64.94+64",
          "ChargeCode": "S",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "58.03+58",
          "TaxAmount": "8.7@8.7/"
        },
        {
          "ChargeAmount": "98.61-98",
          "ChargeCode": "B",
          "ChargeDescription": "FUEL SURCHARGE",
          "IncentedAmount": "61.75_61",
          "TaxAmount": "7.89@7.8"
        }
      ],
      "CurrencyCode": "ETB",
      "Disclaimer": {
        "Code": "05",
        "Description": "Rate excludes VAT"
      },
      "GrandTotalOfAllCharge": "175.97@1",
      "GrandTotalOfAllIncentedCharge": "156.15",
      "PreTaxTotalCharge": "22.26^22",
      "PreTaxTotalIncentedCharge": "115.78",
      "RateType": "FD",
      "TaxCharges": [
        {
          "MonetaryValue": "0.06_0.0",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "2.35@2.3",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "3.66 3.6",
          "Type": "GST"
        },
        {
          "MonetaryValue": "1.19+1.1",
          "Type": "GST"
        }
      ],
      "TotalTax": "13.06/13"
    },
    "Response": {
      "Alert": [
        {
          "Code": "6",
          "Description": "Delivery date modified"
        },
        {
          "Code": "7",
          "Description": "Address verification required"
        },
        {
          "Code": "4",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "BFIiVW18EV"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "N",
      "SunWST": "Y"
    },
    "WeekendServiceTerritoryIndicator": "Y"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "qxUmn",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "JgMKh",
        "message": "Authentication failed"
      },
      {
        "code": "56Sfj",
        "message": "Record not found"
      },
      {
        "code": "VE27e",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "dseYD",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "T6ZAB",
        "message": "Authentication failed"
      }
    ]
  }
}

GET

/shipments/{version}/pickup/{pickuptype}

Using the GET operation of the pickuptype endpoint within the Pickup API, users can retrieve the status of shipments sent via UPS pickup service. The endpoint uses the account number as a required parameter and returns a status of received/dispatched/completed/incomplete/updated ETA, or cancelled.

Header Name	Example
`transId`	`"aute dolore"`
`transactionSrc`	`"velit consequat veniam nostrud enim"`
`AccountNumber`*	`"et do cupidatat"`

Request Payload

Response Payload

{
  "PickupPendingStatusResponse": {
    "PendingStatus": [
      {
        "BillingCode": "ci",
        "ContactName": "sunt dolore ull",
        "GWNStatusCode": "te",
        "OnCallStatusCode": "adi",
        "PickupStatusMessage": "pariatur quis",
        "PickupType": "mo",
        "PRN": "elit in eni",
        "ReferenceNumber": "reprehenderit",
        "ServiceDate": "magna la"
      },
      {
        "BillingCode": "eu",
        "ContactName": "aute ull",
        "GWNStatusCode": "ci",
        "OnCallStatusCode": "sed",
        "PickupStatusMessage": "aliquip enim dolore Duis",
        "PickupType": "re",
        "PRN": "Lorem quis ",
        "ReferenceNumber": "ad officia",
        "ServiceDate": "culpa in"
      },
      {
        "BillingCode": "oc",
        "ContactName": "laborum sed",
        "GWNStatusCode": "ul",
        "OnCallStatusCode": "aut",
        "PickupStatusMessage": "dolore",
        "PickupType": "su",
        "PRN": "non proiden",
        "ReferenceNumber": "consequat",
        "ServiceDate": "exercita"
      },
      {
        "BillingCode": "ut",
        "ContactName": "commodo",
        "GWNStatusCode": "te",
        "OnCallStatusCode": "eiu",
        "PickupStatusMessage": "proident esse",
        "PickupType": "su",
        "PRN": "in veniam d",
        "ReferenceNumber": "anim sit",
        "ServiceDate": "id amete"
      },
      {
        "BillingCode": "ve",
        "ContactName": "est qui voluptate ut",
        "GWNStatusCode": "ir",
        "OnCallStatusCode": "non",
        "PickupStatusMessage": "aute nulla",
        "PickupType": "ve",
        "PRN": "id Lorem ad",
        "ReferenceNumber": "reprehenderit officia",
        "ServiceDate": "nulla su"
      }
    ],
    "Response": {
      "Alert": [
        {
          "Code": "9",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "KrHE01yIvS"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6lDLW",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "Q3Fgj",
        "message": "Invalid request"
      },
      {
        "code": "lWPvH",
        "message": "Record not found"
      },
      {
        "code": "zKl1D",
        "message": "Authentication failed"
      },
      {
        "code": "E7pBX",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ppZgb",
        "message": "Record not found"
      },
      {
        "code": "1iLJz",
        "message": "Invalid request"
      },
      {
        "code": "gnbMw",
        "message": "Invalid request"
      },
      {
        "code": "RJ7uv",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "zlZyH",
        "message": "Invalid request"
      },
      {
        "code": "MQXNU",
        "message": "Authentication failed"
      },
      {
        "code": "52oFn",
        "message": "Record not found"
      },
      {
        "code": "0nVUh",
        "message": "Invalid request"
      },
      {
        "code": "7feOT",
        "message": "Invalid request"
      }
    ]
  }
}

DELETE

/shipments/{version}/pickup/{CancelBy}

Using the CancelBy endpoint of the Pickup API, users can request cancellation of a UPS on-demand package pickup. When the PRN (pickup request number), transaction ID, and the transaction source are supplied as required parameters, the endpoint returns confirmation that the pickup has been cancelled.

Header Name	Example
`transId`	`"adipisicing"`
`transactionSrc`	`"sed Ut"`
`Prn`	`"cillum magna incididunt"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "007",
      "Description": "User Triggered"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "5",
          "Description": "Regional delay expected"
        },
        {
          "Code": "2",
          "Description": "Regional delay expected"
        },
        {
          "Code": "3",
          "Description": "Delivery date modified"
        },
        {
          "Code": "0",
          "Description": "Regional delay expected"
        },
        {
          "Code": "1",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "Fq5qJyVGRC"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "dHKm9",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "Qdc8s",
        "message": "Authentication failed"
      },
      {
        "code": "u0rhQ",
        "message": "Invalid request"
      },
      {
        "code": "Z9AyD",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "VD3FR",
        "message": "Record not found"
      },
      {
        "code": "IsDR4",
        "message": "Invalid request"
      },
      {
        "code": "EngRG",
        "message": "Invalid request"
      },
      {
        "code": "sna6N",
        "message": "Authentication failed"
      },
      {
        "code": "MGbYb",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "MjCfc",
        "message": "Record not found"
      },
      {
        "code": "iKCpJ",
        "message": "Invalid request"
      },
      {
        "code": "LnIU9",
        "message": "Authentication failed"
      }
    ]
  }
}

POST

/pickupcreation/{version}/pickup

Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups.

Header Name	Example
`transId`	`"ea nulla"`
`transactionSrc`	`"ut nisi occaecat"`

Request Payload

{
  "PickupCreationRequest": {
    "RatePickupIndicator": "N",
    "Shipper": {
      "Account": {
        "AccountNumber": "ShipperNumber",
        "AccountCountryCode": "US"
      }
    },
    "PickupDateInfo": {
      "CloseTime": "1400",
      "ReadyTime": "0500",
      "PickupDate": "20221214"
    },
    "PickupAddress": {
      "CompanyName": "Pickup Proxy",
      "ContactName": "Pickup Manager",
      "AddressLine": "123 Main Street",
      "Room": "R01",
      "Floor": "2",
      "City": "Allendale",
      "StateProvince": "NJ",
      "Urbanization": "",
      "PostalCode": "07401",
      "CountryCode": "US",
      "ResidentialIndicator": "Y",
      "PickupPoint": "Lobby",
      "Phone": {
        "Number": "5555555555",
        "Extension": "911"
      }
    },
    "AlternateAddressIndicator": "Y",
    "PickupPiece": [
      {
        "ServiceCode": "001",
        "Quantity": "27",
        "DestinationCountryCode": "US",
        "ContainerCode": "01"
      },
      {
        "ServiceCode": "012",
        "Quantity": "4",
        "DestinationCountryCode": "US",
        "ContainerCode": "01"
      }
    ],
    "TotalWeight": {
      "Weight": "5.5",
      "UnitOfMeasurement": "LBS"
    },
    "OverweightIndicator": "N",
    "PaymentMethod": "01",
    "SpecialInstruction": "Test ",
    "ReferenceNumber": "CreatePickupRef"
  }
}

Response Payload

{
  "PickupCreationResponse": {
    "Response": {
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "Alert": [
        {
          "Code": "string",
          "Description": "string"
        }
      ],
      "TransactionReference": {
        "CustomerContext": "string"
      }
    },
    "PRN": "stringstrin",
    "WeekendServiceTerritory": {
      "SatWST": "s",
      "SunWST": "s"
    },
    "WeekendServiceTerritoryIndicator": "s",
    "RateStatus": {
      "Code": "st",
      "Description": "string"
    },
    "RateResult": {
      "Disclaimer": {
        "Code": "st",
        "Description": "string"
      },
      "RateType": "st",
      "CurrencyCode": "str",
      "ChargeDetail": [
        {
          "ChargeCode": "s",
          "ChargeDescription": "string",
          "ChargeAmount": "stringst",
          "IncentedAmount": "stringst",
          "TaxAmount": "stringst"
        }
      ],
      "TaxCharges": [
        {
          "Type": "str",
          "MonetaryValue": "stringst"
        }
      ],
      "TotalTax": "stringst",
      "GrandTotalOfAllCharge": "stringst",
      "GrandTotalOfAllIncentedCharge": "string",
      "PreTaxTotalCharge": "stringst",
      "PreTaxTotalIncentedCharge": "string"
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "WrAg7",
        "message": "Invalid request"
      },
      {
        "code": "F4ErT",
        "message": "Invalid request"
      },
      {
        "code": "nqYoq",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "C9G2D",
        "message": "Invalid request"
      },
      {
        "code": "Dpinv",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8aWSX",
        "message": "Invalid request"
      },
      {
        "code": "WABAm",
        "message": "Authentication failed"
      },
      {
        "code": "zbRYT",
        "message": "Authentication failed"
      },
      {
        "code": "rEdTZ",
        "message": "Record not found"
      },
      {
        "code": "mH8zr",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "66elr",
        "message": "Record not found"
      },
      {
        "code": "iYipt",
        "message": "Authentication failed"
      },
      {
        "code": "BA0n8",
        "message": "Authentication failed"
      },
      {
        "code": "VhMZ1",
        "message": "Record not found"
      },
      {
        "code": "WbjJ3",
        "message": "Authentication failed"
      }
    ]
  }
}

GET

/pickup/{version}/countries/{countrycode}

The countrycode endpoint of the Pickup API helps retrieve a list of political divisions (states) in a specified country or territory.

Header Name	Example
`transId`*	`"culpa ea nostrud voluptate in"`
`transactionSrc`*	`"veniam"`

Request Payload

Response Payload

{
  "PickupGetPoliticalDivision1ListResponse": {
    "PoliticalDivision1": [
      "in nostrud",
      "mollit eu magna fugiat",
      "Duis esse",
      "ipsum culpa veniam est",
      "commodo magna Excepteur Duis"
    ],
    "Response": {
      "Alert": [
        {
          "Code": "1",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "99IoFvkwNY"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "cbCl6",
        "message": "Record not found"
      },
      {
        "code": "s1gqK",
        "message": "Invalid request"
      },
      {
        "code": "DfLJg",
        "message": "Record not found"
      },
      {
        "code": "oPPpj",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "YFqds",
        "message": "Record not found"
      },
      {
        "code": "Epfdi",
        "message": "Invalid request"
      },
      {
        "code": "mlSxC",
        "message": "Invalid request"
      },
      {
        "code": "msJif",
        "message": "Record not found"
      },
      {
        "code": "53pw1",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "7CNQI",
        "message": "Record not found"
      },
      {
        "code": "VIHdr",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "T1YjC",
        "message": "Record not found"
      },
      {
        "code": "3mFfe",
        "message": "Record not found"
      },
      {
        "code": "oAjSv",
        "message": "Record not found"
      }
    ]
  }
}

POST

/pickup/{version}/servicecenterlocations

The servicecenterlocations endpoint of the Pickup API helps retrieve service center information in a specified area - including location address, phone number, SLIC (Standard Location Identification Code), and hours of operation for pick-up and drop-off requests

Header Name	Example
`transId`	`"sit eu ullamco cillum"`
`transactionSrc`	`"deserunt dolore velit et"`

Request Payload

{
  "PickupGetServiceCenterFacilitiesRequest": {
    "PickupPiece": {
      "ServiceCode": "096",
      "ContainerCode": "03"
    },
    "DestinationAddress": {
      "City": "Allendale",
      "StateProvince": "NJ",
      "PostalCode": "07401",
      "CountryCode": "US"
    },
    "ProximitySearchIndicator": "",
    "Locale": "en_HK"
  }
}

Response Payload

{
  "PickupGetServiceCenterFacilitiesResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "0",
          "Description": "Regional delay expected"
        },
        {
          "Code": "0",
          "Description": "Delivery date modified"
        },
        {
          "Code": "7",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "YmN7tYRdlT"
      }
    },
    "ServiceCenterLocation": {
      "DropOffFacilities": [
        {
          "Address": {
            "AddressLine": [
              "nulla laboris in qui",
              "commodo elit",
              "quis"
            ],
            "City": "Ut eu ut",
            "CountryCode": "e",
            "PostalCode": "proident",
            "ResidentialIndicator": "a",
            "StateProvince": "amet dolor Lorem reprehenderit"
          },
          "Distance": {
            "UnitOfMeasurement": "co",
            "Value": "in qui"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "dolore culpadolore d",
                "Day": "deserunt U",
                "EarliestDropOfforPickup": "sunt aliqu",
                "LastDrop": "commodo proident lab",
                "LatestDropOfforPickup": "irurerepre",
                "OpenHours": "qui do fugiatut culp",
                "PrepTime": "deserunt magna ut te"
              },
              {
                "CloseHours": "sint nulla occaecats",
                "Day": "ad Ut id q",
                "EarliestDropOfforPickup": "est cupida",
                "LastDrop": "magnaesse laboreea c",
                "LatestDropOfforPickup": "uteiusmod ",
                "OpenHours": "ut enim occaecatanim",
                "PrepTime": "dolore anim eiusmod "
              },
              {
                "CloseHours": "labore commodo ut ea",
                "Day": "culpa dolo",
                "EarliestDropOfforPickup": "aliqua sun",
                "LastDrop": "eiusmod laborumsint ",
                "LatestDropOfforPickup": "in occaeca",
                "OpenHours": "aute reprehenderit c",
                "PrepTime": "amet nostrudnostrud "
              },
              {
                "CloseHours": "aute incididunt veni",
                "Day": "molliteu e",
                "EarliestDropOfforPickup": "exercitati",
                "LastDrop": "ullamco laborum inel",
                "LatestDropOfforPickup": "commodo ni",
                "OpenHours": "laborum consequat co",
                "PrepTime": "Lorem etad reprehend"
              }
            ]
          },
          "Fax": "mollitnisi",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "voluptate sunt est",
              "Locale": "conse"
            },
            {
              "Last50ftInstruction": "ut quis",
              "Locale": "ullam"
            },
            {
              "Last50ftInstruction": "cupidatat Duis",
              "Locale": "culpa"
            },
            {
              "Last50ftInstruction": "fugiat nostrud cupidatat culpa ipsum",
              "Locale": "eaadi"
            },
            {
              "Last50ftInstruction": "mollit consequat in",
              "Locale": "enim "
            }
          ],
          "Name": "tempor laboris",
          "OriginOrDestination": "consectetur mollit culpa",
          "Phone": "in incidid",
          "SLIC": "repre",
          "Timezone": "nostrud",
          "Type": "iru"
        },
        {
          "Address": {
            "AddressLine": "voluptate aliquip dolor",
            "City": "Excepteur in",
            "CountryCode": "e",
            "PostalCode": "voluptat",
            "ResidentialIndicator": "c",
            "StateProvince": "Lorem"
          },
          "Distance": {
            "UnitOfMeasurement": "ve",
            "Value": "aute L"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "sit ullamco exincidi",
                "Day": "eiusmod co",
                "EarliestDropOfforPickup": "Ut dolore ",
                "LastDrop": "voluptate utamet do ",
                "LatestDropOfforPickup": "proident o",
                "OpenHours": "sit consecteturirure",
                "PrepTime": "tempor et minimin ip"
              },
              {
                "CloseHours": "nostrud suntmollit n",
                "Day": "ullamconos",
                "EarliestDropOfforPickup": "velit aliq",
                "LastDrop": "dolor eumagna sedven",
                "LatestDropOfforPickup": "ea adipisi",
                "OpenHours": "aliquip Ut cupidatat",
                "PrepTime": "mollit essemollitdo "
              },
              {
                "CloseHours": "in enim quis Lorem i",
                "Day": "nonlaborum",
                "EarliestDropOfforPickup": "enim paria",
                "LastDrop": "doloreexpariatur eu ",
                "LatestDropOfforPickup": "anim eiusm",
                "OpenHours": "mollit officiado des",
                "PrepTime": "et sint magna Duis d"
              },
              {
                "CloseHours": "magna reprehenderits",
                "Day": "est Except",
                "EarliestDropOfforPickup": "Excepteur ",
                "LastDrop": "esse commodoUt volup",
                "LatestDropOfforPickup": "Loremanim ",
                "OpenHours": "qui irure nullaullam",
                "PrepTime": "auteculpaeteu ullamc"
              }
            ]
          },
          "Fax": "ut irure e",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "est sed",
              "Locale": "amet "
            },
            {
              "Last50ftInstruction": "Excepteur",
              "Locale": "adipi"
            },
            {
              "Last50ftInstruction": "reprehenderit elit veniam Excepteur",
              "Locale": "paria"
            },
            {
              "Last50ftInstruction": "irure deserunt commodo quis magna",
              "Locale": "dolor"
            }
          ],
          "Name": "ex",
          "OriginOrDestination": "deserunt fugiat eu adipisicing",
          "Phone": "occaecatoc",
          "SLIC": "con",
          "Timezone": "magna Ut aliqua culpa minim",
          "Type": "exe"
        }
      ],
      "PickupFacilities": {
        "Address": {
          "AddressLine": "proident fugiat ea ",
          "City": "reprehenderit",
          "CountryCode": "es",
          "PostalCode": "ea en",
          "ResidentialIndicator": "m",
          "StateProvince": "ad ut dolore laboris officia"
        },
        "AirportCode": "par",
        "FacilityTime": {
          "DayOfWeek": [
            {
              "CloseHours": "voluptate non mollit",
              "Day": "reprehende",
              "EarliestDropOfforPickup": "incididunt",
              "LastDrop": "anim nulla nisiin la",
              "LatestDropOfforPickup": "magna offi",
              "OpenHours": "minim ullamco dolor ",
              "PrepTime": "sint velit doloreeiu"
            },
            {
              "CloseHours": "sed culpa nisi id qu",
              "Day": "tempor in ",
              "EarliestDropOfforPickup": "qui in aut",
              "LastDrop": "in eu estdeserunt in",
              "LatestDropOfforPickup": "in minim q",
              "OpenHours": "laboreet laborein an",
              "PrepTime": "incididunt velit ani"
            },
            {
              "CloseHours": "laboris aliquip in p",
              "Day": "ipsumquis ",
              "EarliestDropOfforPickup": "Lorem dese",
              "LastDrop": "inanim Utullamco ame",
              "LatestDropOfforPickup": "exercitati",
              "OpenHours": "reprehenderit nisi U",
              "PrepTime": "quisanim doloret occ"
            },
            {
              "CloseHours": "in adipisicing Excep",
              "Day": "tempor Ut ",
              "EarliestDropOfforPickup": "eu consequ",
              "LastDrop": "adipisicingnisi est ",
              "LatestDropOfforPickup": "officia si",
              "OpenHours": "fugiat Loremnostrud ",
              "PrepTime": "aliquipexercitation "
            }
          ]
        },
        "Fax": "occaecat i",
        "Name": "proident occaecat est fugiat",
        "Phone": "sint dolor",
        "SLIC": "labor",
        "SortCode": "et",
        "Timezone": "incidid",
        "Type": "sin"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "sA4bt",
        "message": "Invalid request"
      },
      {
        "code": "GfOfI",
        "message": "Authentication failed"
      },
      {
        "code": "HG9qG",
        "message": "Record not found"
      },
      {
        "code": "oJmWl",
        "message": "Invalid request"
      },
      {
        "code": "rXUHo",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ajWCd",
        "message": "Invalid request"
      },
      {
        "code": "a5A3C",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ZUkY3",
        "message": "Invalid request"
      },
      {
        "code": "FFfUs",
        "message": "Invalid request"
      },
      {
        "code": "QRnx5",
        "message": "Record not found"
      },
      {
        "code": "z1iLR",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "KjfCX",
        "message": "Authentication failed"
      },
      {
        "code": "EKnO0",
        "message": "Authentication failed"
      },
      {
        "code": "YHQDa",
        "message": "Invalid request"
      }
    ]
  }
}

DELETE

/shipments/{deprecatedVersion}/pickup/{CancelBy}

Header Name	Example
`transId`	`"Excepteur"`
`transactionSrc`	`"officia mollit nulla exercitation est"`
`Prn`	`"enim labore in laboris"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "003",
      "Description": "Completed"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "9",
          "Description": "Regional delay expected"
        },
        {
          "Code": "1",
          "Description": "Address verification required"
        },
        {
          "Code": "6",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "gON2U4btBy"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "RCOjK",
        "message": "Record not found"
      },
      {
        "code": "S0c7u",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "jAWiD",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "AdgpY",
        "message": "Authentication failed"
      },
      {
        "code": "6fhzk",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "CARq8",
        "message": "Invalid request"
      },
      {
        "code": "BjHDC",
        "message": "Record not found"
      },
      {
        "code": "l9WpR",
        "message": "Invalid request"
      }
    ]
  }
}

POST

/pickupcreation/{deprecatedVersion}/pickup

Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups.

Header Name	Example
`transId`	`"nulla anim sunt aliquip"`
`transactionSrc`	`"reprehenderit voluptate minim"`

Request Payload

{
  "PickupCreationRequest": {
    "RatePickupIndicator": "N",
    "Shipper": {
      "Account": {
        "AccountNumber": "ShipperNumber",
        "AccountCountryCode": "US"
      }
    },
    "PickupDateInfo": {
      "CloseTime": "1400",
      "ReadyTime": "0500",
      "PickupDate": "20221214"
    },
    "PickupAddress": {
      "CompanyName": "Pickup Proxy",
      "ContactName": "Pickup Manager",
      "AddressLine": "123 Main Street",
      "Room": "R01",
      "Floor": "2",
      "City": "Allendale",
      "StateProvince": "NJ",
      "Urbanization": "",
      "PostalCode": "07401",
      "CountryCode": "US",
      "ResidentialIndicator": "Y",
      "PickupPoint": "Lobby",
      "Phone": {
        "Number": "5555555555",
        "Extension": "911"
      }
    },
    "AlternateAddressIndicator": "Y",
    "PickupPiece": [
      {
        "ServiceCode": "001",
        "Quantity": "27",
        "DestinationCountryCode": "US",
        "ContainerCode": "01"
      },
      {
        "ServiceCode": "012",
        "Quantity": "4",
        "DestinationCountryCode": "US",
        "ContainerCode": "01"
      }
    ],
    "TotalWeight": {
      "Weight": "5.5",
      "UnitOfMeasurement": "LBS"
    },
    "OverweightIndicator": "N",
    "PaymentMethod": "01",
    "SpecialInstruction": "Test ",
    "ReferenceNumber": "CreatePickupRef"
  }
}

Response Payload

{
  "PickupCreationResponse": {
    "PRN": "fo4B2b4VNge",
    "RateResult": {
      "ChargeDetail": [
        {
          "ChargeAmount": "46.33/46",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "53.3=53.",
          "TaxAmount": "3.22+3.2"
        },
        {
          "ChargeAmount": "45.92/45",
          "ChargeCode": "B",
          "ChargeDescription": "BASE CHARGE",
          "IncentedAmount": "44.97 44",
          "TaxAmount": "1.89/1.8"
        },
        {
          "ChargeAmount": "33.6 33.",
          "ChargeCode": "A",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "54.12^54",
          "TaxAmount": "2.17 2.1"
        },
        {
          "ChargeAmount": "57.69+57",
          "ChargeCode": "A",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "49.34+49",
          "TaxAmount": "9.77 9.7"
        },
        {
          "ChargeAmount": "14.25/14",
          "ChargeCode": "S",
          "ChargeDescription": "FUEL SURCHARGE",
          "IncentedAmount": "10.1-10.",
          "TaxAmount": "0.73@0.7"
        }
      ],
      "CurrencyCode": "dol",
      "Disclaimer": {
        "Code": "02",
        "Description": "Rate excludes VAT"
      },
      "GrandTotalOfAllCharge": "ut magna",
      "GrandTotalOfAllIncentedCharge": "ipsu",
      "PreTaxTotalCharge": "cupidata",
      "PreTaxTotalIncentedCharge": "sint e",
      "RateType": "en",
      "TaxCharges": [
        {
          "MonetaryValue": "2.16_2.1",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "1 1 1 1_",
          "Type": "GST"
        },
        {
          "MonetaryValue": "1.18/1.1",
          "Type": "PST"
        },
        {
          "MonetaryValue": "4.46-4.4",
          "Type": "PST"
        },
        {
          "MonetaryValue": "0.87=0.8",
          "Type": "VAT"
        }
      ],
      "TotalTax": "nulla mo"
    },
    "RateStatus": {
      "Code": "04",
      "Description": "commodo non"
    },
    "Response": {
      "Alert": [
        {
          "Code": "3",
          "Description": "Regional delay expected"
        },
        {
          "Code": "4",
          "Description": "Regional delay expected"
        },
        {
          "Code": "1",
          "Description": "Address verification required"
        },
        {
          "Code": "5",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "bXe7mN57jE"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "i",
      "SunWST": "c"
    },
    "WeekendServiceTerritoryIndicator": "d"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "F1SCh",
        "message": "Record not found"
      },
      {
        "code": "aGccT",
        "message": "Invalid request"
      },
      {
        "code": "qAfZ4",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "uizlh",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "dPOph",
        "message": "Record not found"
      },
      {
        "code": "sFl02",
        "message": "Authentication failed"
      },
      {
        "code": "jj4s1",
        "message": "Record not found"
      },
      {
        "code": "1CJqK",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ARwnp",
        "message": "Authentication failed"
      },
      {
        "code": "7AIlA",
        "message": "Record not found"
      },
      {
        "code": "EyMLi",
        "message": "Record not found"
      }
    ]
  }
}

Service Homepage: github.com/UPS-API/api-documentation/blob/main/Pickup.yaml

upslogisticsshippingpickupsupply-chain