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`	`"ut in nostrud adipisicing"`
`transactionSrc`	`"Duis ullamco tempor"`

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": "39.85/39",
          "ChargeCode": "A",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "84.14^84",
          "TaxAmount": "8.11 8.1"
        },
        {
          "ChargeAmount": "36.58/36",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "27.99_27",
          "TaxAmount": "6.84^6.8"
        },
        {
          "ChargeAmount": "7.49/7.4",
          "ChargeCode": "A",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "86.75^86",
          "TaxAmount": "4.95/4.9"
        },
        {
          "ChargeAmount": "33.92 33",
          "ChargeCode": "S",
          "ChargeDescription": "BASE CHARGE",
          "IncentedAmount": "17.69_17",
          "TaxAmount": "0.09+0.0"
        },
        {
          "ChargeAmount": "90.93-90",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "44.18@44",
          "TaxAmount": "8.81=8.8"
        }
      ],
      "CurrencyCode": "XOF",
      "Disclaimer": {
        "Code": "01",
        "Description": "Taxes are included"
      },
      "GrandTotalOfAllCharge": "118.41 1",
      "GrandTotalOfAllIncentedCharge": "73.63",
      "PreTaxTotalCharge": "65.83-65",
      "PreTaxTotalIncentedCharge": "76.47",
      "RateType": "SD",
      "TaxCharges": [
        {
          "MonetaryValue": "4.53+4.5",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "0.82@0.8",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "1.5 1.5+",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "4.1 4.1^",
          "Type": "GST"
        },
        {
          "MonetaryValue": "1.62-1.6",
          "Type": "VAT"
        }
      ],
      "TotalTax": "19.92=19"
    },
    "Response": {
      "Alert": [
        {
          "Code": "4",
          "Description": "Regional delay expected"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        },
        {
          "Code": "1",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "zMCfC3SQ5f"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "Y",
      "SunWST": "N"
    },
    "WeekendServiceTerritoryIndicator": "Y"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "MciSK",
        "message": "Authentication failed"
      },
      {
        "code": "KJA9O",
        "message": "Invalid request"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "g5TUL",
        "message": "Authentication failed"
      },
      {
        "code": "6cPIr",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "y6Jgq",
        "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`	`"laborum incididunt ullamco Ut pariatur"`
`transactionSrc`	`"tempor dolore aliqua culpa sed"`
`AccountNumber`*	`"labore id sunt do"`

Request Payload

Response Payload

{
  "PickupPendingStatusResponse": {
    "PendingStatus": [
      {
        "BillingCode": "eu",
        "ContactName": "ut id l",
        "GWNStatusCode": "si",
        "OnCallStatusCode": "ad ",
        "PickupStatusMessage": "eu qui id labore",
        "PickupType": "vo",
        "PRN": "do adipisic",
        "ReferenceNumber": "fugiat veniam Excepteur",
        "ServiceDate": "proident"
      },
      {
        "BillingCode": "ma",
        "ContactName": "molli",
        "GWNStatusCode": "ut",
        "OnCallStatusCode": "vol",
        "PickupStatusMessage": "in dolor dolore qui nulla",
        "PickupType": "ea",
        "PRN": "sitadipisic",
        "ReferenceNumber": "fugiat aliquip sunt",
        "ServiceDate": "do molli"
      },
      {
        "BillingCode": "Ex",
        "ContactName": "in proident",
        "GWNStatusCode": "el",
        "OnCallStatusCode": "par",
        "PickupStatusMessage": "consectetur in",
        "PickupType": "la",
        "PRN": "qui mollit ",
        "ReferenceNumber": "laboris officia ea Lorem",
        "ServiceDate": "sed mini"
      },
      {
        "BillingCode": "su",
        "ContactName": "irure d",
        "GWNStatusCode": "ir",
        "OnCallStatusCode": "mol",
        "PickupStatusMessage": "laborum ut",
        "PickupType": "ut",
        "PRN": "cillum est ",
        "ReferenceNumber": "ut",
        "ServiceDate": "pariatur"
      }
    ],
    "Response": {
      "Alert": [
        {
          "Code": "1",
          "Description": "Regional delay expected"
        },
        {
          "Code": "1",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "CzX74oB32P"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "kFFnQ",
        "message": "Invalid request"
      },
      {
        "code": "ezJJc",
        "message": "Invalid request"
      },
      {
        "code": "ebI7d",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "PdZlb",
        "message": "Record not found"
      },
      {
        "code": "QNZ6M",
        "message": "Record not found"
      },
      {
        "code": "rgWiD",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "wk4B1",
        "message": "Invalid request"
      },
      {
        "code": "F3pry",
        "message": "Invalid request"
      },
      {
        "code": "awY91",
        "message": "Record not found"
      },
      {
        "code": "suw9i",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "DHKNZ",
        "message": "Record not found"
      },
      {
        "code": "ZRvJ9",
        "message": "Invalid request"
      },
      {
        "code": "tklZe",
        "message": "Invalid request"
      },
      {
        "code": "Dgb5l",
        "message": "Record not found"
      }
    ]
  }
}

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`	`"sint dolore Duis qui elit"`
`transactionSrc`	`"dolor sed mollit"`
`Prn`	`"Ut"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "002",
      "Description": "Completed"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "9",
          "Description": "Regional delay expected"
        },
        {
          "Code": "8",
          "Description": "Delivery date modified"
        },
        {
          "Code": "5",
          "Description": "Regional delay expected"
        },
        {
          "Code": "3",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "h38OjDsG9o"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "y6rU2",
        "message": "Authentication failed"
      },
      {
        "code": "zURZn",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "muZw4",
        "message": "Record not found"
      },
      {
        "code": "hHGMy",
        "message": "Authentication failed"
      },
      {
        "code": "oNHXS",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "wyKjp",
        "message": "Record not found"
      },
      {
        "code": "dJk59",
        "message": "Authentication failed"
      },
      {
        "code": "eKBo3",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "BfUGS",
        "message": "Invalid request"
      },
      {
        "code": "GMvnP",
        "message": "Authentication failed"
      },
      {
        "code": "RKGo1",
        "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`	`"commodo cillum Ut"`
`transactionSrc`	`"sit consequat"`

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": "1XvG2",
        "message": "Authentication failed"
      },
      {
        "code": "LKBrV",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ZTcgj",
        "message": "Invalid request"
      },
      {
        "code": "uoyHc",
        "message": "Authentication failed"
      },
      {
        "code": "SdWX2",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "K6LGi",
        "message": "Authentication failed"
      },
      {
        "code": "Yx0g7",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "IG44T",
        "message": "Invalid request"
      },
      {
        "code": "6pfro",
        "message": "Record not found"
      }
    ]
  }
}

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`*	`"ipsum Excepteur"`
`transactionSrc`*	`"in occaecat deserunt non dolore"`

Request Payload

Response Payload

{
  "PickupGetPoliticalDivision1ListResponse": {
    "PoliticalDivision1": [
      "incididunt proident nostrud tempor"
    ],
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Regional delay expected"
        },
        {
          "Code": "6",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "vOt70c9KWT"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "wK8uJ",
        "message": "Invalid request"
      },
      {
        "code": "Fz9VV",
        "message": "Invalid request"
      },
      {
        "code": "kMliG",
        "message": "Invalid request"
      },
      {
        "code": "fNEqs",
        "message": "Record not found"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "UZuwj",
        "message": "Record not found"
      },
      {
        "code": "kfOPw",
        "message": "Authentication failed"
      },
      {
        "code": "0djlk",
        "message": "Authentication failed"
      },
      {
        "code": "Zftuq",
        "message": "Record not found"
      }
    ]
  }
}

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

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`	`"occaecat Ut"`
`transactionSrc`	`"laboris aliquip"`

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": "2",
          "Description": "Regional delay expected"
        },
        {
          "Code": "8",
          "Description": "Regional delay expected"
        },
        {
          "Code": "8",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "wChu3J8A7t"
      }
    },
    "ServiceCenterLocation": {
      "DropOffFacilities": [
        {
          "Address": {
            "AddressLine": [
              "nisi in"
            ],
            "City": "commodo mollit eiusmod",
            "CountryCode": "min",
            "PostalCode": "commodo ",
            "ResidentialIndicator": "L",
            "StateProvince": "mollit"
          },
          "Distance": {
            "UnitOfMeasurement": "fu",
            "Value": "sunt u"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "qui consequat dolor ",
                "Day": "Ut nostrud",
                "EarliestDropOfforPickup": "laborisess",
                "LastDrop": "anim occaecatveniam ",
                "LatestDropOfforPickup": "nostrud ut",
                "OpenHours": "esse dolor inelit al",
                "PrepTime": "in quimollitea in vo"
              },
              {
                "CloseHours": "magna nostrudlaborum",
                "Day": "ut indo au",
                "EarliestDropOfforPickup": "veniam qui",
                "LastDrop": "esse sed id laboris ",
                "LatestDropOfforPickup": "doaliqua i",
                "OpenHours": "excommodo nostrud re",
                "PrepTime": "inlabore animmagna v"
              },
              {
                "CloseHours": "pariaturaliquip moll",
                "Day": "consequat ",
                "EarliestDropOfforPickup": "velit inet",
                "LastDrop": "eiusmodut Excepteurd",
                "LatestDropOfforPickup": "dolor moll",
                "OpenHours": "magna cupidatat sit ",
                "PrepTime": "magna voluptate amet"
              },
              {
                "CloseHours": "dolore innostrud dol",
                "Day": "ut do estc",
                "EarliestDropOfforPickup": "qui aliqui",
                "LastDrop": "ut laborum ipsum con",
                "LatestDropOfforPickup": "Loremvenia",
                "OpenHours": "est ad culpa labore ",
                "PrepTime": "laborisadipisicing u"
              },
              {
                "CloseHours": "ex nulladeserunt qui",
                "Day": "qui dolore",
                "EarliestDropOfforPickup": "culpa estc",
                "LastDrop": "sint dolorenon autei",
                "LatestDropOfforPickup": "ex irurein",
                "OpenHours": "dolor ut eiusmod dol",
                "PrepTime": "aute exercitation la"
              }
            ]
          },
          "Fax": "eiusmod au",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "minim ut exercitation Ut",
              "Locale": "dolor"
            },
            {
              "Last50ftInstruction": "consequat",
              "Locale": "esse "
            },
            {
              "Last50ftInstruction": "anim pariatur eiusmod irure",
              "Locale": "magna"
            },
            {
              "Last50ftInstruction": "irure in consequat labor",
              "Locale": "non a"
            },
            {
              "Last50ftInstruction": "qui",
              "Locale": "adipi"
            }
          ],
          "Name": "consequat incididunt in proident",
          "OriginOrDestination": "anim cillum eiusmod",
          "Phone": "eu non qui",
          "SLIC": "a",
          "Timezone": "id dolor in esse",
          "Type": "lab"
        },
        {
          "Address": {
            "AddressLine": [
              "dolor dolore est labore",
              "labore velit",
              "laboris",
              "culpa"
            ],
            "City": "consectetur",
            "CountryCode": "et ",
            "PostalCode": "ullamco ",
            "ResidentialIndicator": "s",
            "StateProvince": "occaecat temp"
          },
          "Distance": {
            "UnitOfMeasurement": "an",
            "Value": "exerci"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "ex irure culpasint i",
                "Day": "sit exerci",
                "EarliestDropOfforPickup": "consectetu",
                "LastDrop": "proident minim do fu",
                "LatestDropOfforPickup": "in aliqua ",
                "OpenHours": "esse deserunt consec",
                "PrepTime": "aliquipnisi ut ametl"
              },
              {
                "CloseHours": "aliqua sit laborisqu",
                "Day": "deseruntma",
                "EarliestDropOfforPickup": "et irure a",
                "LastDrop": "magna fugiat consequ",
                "LatestDropOfforPickup": "incididunt",
                "OpenHours": "cupidatatelit sed su",
                "PrepTime": "quis occaecat Lorem "
              }
            ]
          },
          "Fax": "dolore Ut ",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "cupidatat",
              "Locale": "incid"
            },
            {
              "Last50ftInstruction": "consequat minim laboris incididunt sunt",
              "Locale": "sinte"
            }
          ],
          "Name": "non",
          "OriginOrDestination": "aute",
          "Phone": "enim fugia",
          "SLIC": "labor",
          "Timezone": "vo",
          "Type": "Exc"
        },
        {
          "Address": {
            "AddressLine": [
              "amet qui id",
              "dolore dolor dolore"
            ],
            "City": "ipsum",
            "CountryCode": "qui",
            "PostalCode": "cupidata",
            "ResidentialIndicator": "i",
            "StateProvince": "occaecat "
          },
          "Distance": {
            "UnitOfMeasurement": "no",
            "Value": "velit "
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "nostrudExcepteur min",
                "Day": "enimtempor",
                "EarliestDropOfforPickup": "irure volu",
                "LastDrop": "Ut et magna labore n",
                "LatestDropOfforPickup": "veniam vel",
                "OpenHours": "labore nulla est mol",
                "PrepTime": "irure sed reprehende"
              },
              {
                "CloseHours": "quis fugiat nisi eni",
                "Day": "Ut ipsum l",
                "EarliestDropOfforPickup": "nonin sitc",
                "LastDrop": "est idanim sintvelit",
                "LatestDropOfforPickup": "sed eiusmo",
                "OpenHours": "dolor nisivelitvelit",
                "PrepTime": "dolor est nulla nisi"
              },
              {
                "CloseHours": "non Excepteur est vo",
                "Day": "Lorem labo",
                "EarliestDropOfforPickup": "in exercit",
                "LastDrop": "dolore aliquip aliqu",
                "LatestDropOfforPickup": "euullamco ",
                "OpenHours": "idculpa incididunt t",
                "PrepTime": "labore deserunt comm"
              },
              {
                "CloseHours": "officia Loremaliqua ",
                "Day": "qui sed ni",
                "EarliestDropOfforPickup": "aliqua con",
                "LastDrop": "veniam magnaveniamla",
                "LatestDropOfforPickup": "cupidatatr",
                "OpenHours": "mollit amet Duis ad ",
                "PrepTime": "dolore suntenimullam"
              }
            ]
          },
          "Fax": "sit utin e",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "quis Excepteur ex in magna",
              "Locale": "do cu"
            },
            {
              "Last50ftInstruction": "quis mollit Ut eiusmod Lorem",
              "Locale": "culpa"
            },
            {
              "Last50ftInstruction": "eiusmod tempor deserunt",
              "Locale": "eiusm"
            },
            {
              "Last50ftInstruction": "anim dolor voluptate officia minim",
              "Locale": "dolor"
            },
            {
              "Last50ftInstruction": "quis",
              "Locale": "elit "
            }
          ],
          "Name": "exercitation consectetur magna Duis",
          "OriginOrDestination": "in aliquip proident ut",
          "Phone": "adipisicin",
          "SLIC": "ullam",
          "Timezone": "deserunt pariatur dolor s",
          "Type": "tem"
        },
        {
          "Address": {
            "AddressLine": "sint consectetur non esse pariatur",
            "City": "Excepteur in laborum",
            "CountryCode": "min",
            "PostalCode": "ipsum do",
            "ResidentialIndicator": "m",
            "StateProvince": "id"
          },
          "Distance": {
            "UnitOfMeasurement": "ul",
            "Value": "ullamc"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "culpa laboris incidi",
                "Day": "cillum etl",
                "EarliestDropOfforPickup": "laborumani",
                "LastDrop": "exercitation laborum",
                "LatestDropOfforPickup": "dolorein e",
                "OpenHours": "enim esselaboris ut ",
                "PrepTime": "enim sed dolore labo"
              }
            ]
          },
          "Fax": "incididunt",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "dolor sint",
              "Locale": "ex in"
            },
            {
              "Last50ftInstruction": "fugiat sed",
              "Locale": "nulla"
            },
            {
              "Last50ftInstruction": "tempor et amet cupidatat nostrud",
              "Locale": "cillu"
            }
          ],
          "Name": "amet officia quis elit",
          "OriginOrDestination": "pariatur id",
          "Phone": "velit cupi",
          "SLIC": "in el",
          "Timezone": "aute esse",
          "Type": "ex "
        },
        {
          "Address": {
            "AddressLine": [
              "ut et proident consectetur",
              "enim ut Ut minim"
            ],
            "City": "nulla laboris culpa cillu",
            "CountryCode": "do",
            "PostalCode": "dolore s",
            "ResidentialIndicator": "d",
            "StateProvince": "qui nostrud in"
          },
          "Distance": {
            "UnitOfMeasurement": "fu",
            "Value": "ex nos"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "dolor aute inofficia",
                "Day": "inlabore o",
                "EarliestDropOfforPickup": "do et temp",
                "LastDrop": "in dolor veniamut cu",
                "LatestDropOfforPickup": "reprehende",
                "OpenHours": "Ut nisi doloresint a",
                "PrepTime": "et occaecat reprehen"
              }
            ]
          },
          "Fax": "in esse do",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "eu eiusmod",
              "Locale": "aute "
            }
          ],
          "Name": "laborum veniam",
          "OriginOrDestination": "Excepteur et in",
          "Phone": "fugiat eni",
          "SLIC": "sint",
          "Timezone": "nisi minim do",
          "Type": "ame"
        }
      ],
      "PickupFacilities": {
        "Address": {
          "AddressLine": "incididunt qui",
          "City": "consectetur ",
          "CountryCode": "si",
          "PostalCode": "deserunt",
          "ResidentialIndicator": "a",
          "StateProvince": "in mollit culp"
        },
        "AirportCode": "rep",
        "FacilityTime": {
          "DayOfWeek": [
            {
              "CloseHours": "dolor enimdeserunt i",
              "Day": "aute nostr",
              "EarliestDropOfforPickup": "cupidatat ",
              "LastDrop": "et officia ad sitdol",
              "LatestDropOfforPickup": "qui dolor ",
              "OpenHours": "ullamco pariatur vel",
              "PrepTime": "adipisicing est labo"
            },
            {
              "CloseHours": "sedexercitation offi",
              "Day": "minim cons",
              "EarliestDropOfforPickup": "minim admi",
              "LastDrop": "adipisicing enim est",
              "LatestDropOfforPickup": "officia do",
              "OpenHours": "anim Duis exercitati",
              "PrepTime": "Lorem qui Ut et Exce"
            },
            {
              "CloseHours": "mollit Ut laboris pr",
              "Day": "laborum ir",
              "EarliestDropOfforPickup": "in aliquae",
              "LastDrop": "Loremfugiat pariatur",
              "LatestDropOfforPickup": "doloreexer",
              "OpenHours": "cillum inaliqua nisi",
              "PrepTime": "dolor laborum situll"
            },
            {
              "CloseHours": "doloranim adipisicin",
              "Day": "fugiat cup",
              "EarliestDropOfforPickup": "inproident",
              "LastDrop": "magnaDuis consequati",
              "LatestDropOfforPickup": "nostrud et",
              "OpenHours": "aliquamagna Excepteu",
              "PrepTime": "enim Excepteur ullam"
            },
            {
              "CloseHours": "dolore ametUt eiusmo",
              "Day": "Excepteur ",
              "EarliestDropOfforPickup": "et non sin",
              "LastDrop": "laboris labore conse",
              "LatestDropOfforPickup": "iruredolor",
              "OpenHours": "tempor labore eiusmo",
              "PrepTime": "ipsum nulla nonirure"
            }
          ]
        },
        "Fax": "Ut Duis nu",
        "Name": "in sit amet qui nulla",
        "Phone": "consequat ",
        "SLIC": "au",
        "SortCode": "qu",
        "Timezone": "ut dolore do",
        "Type": "dol"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "QQNhb",
        "message": "Invalid request"
      },
      {
        "code": "WGtQa",
        "message": "Record not found"
      },
      {
        "code": "qZ29R",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "MPojN",
        "message": "Authentication failed"
      },
      {
        "code": "yLqFa",
        "message": "Authentication failed"
      },
      {
        "code": "NOp8H",
        "message": "Authentication failed"
      },
      {
        "code": "gltzm",
        "message": "Authentication failed"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "Ecxdm",
        "message": "Authentication failed"
      },
      {
        "code": "zmgsu",
        "message": "Invalid request"
      }
    ]
  }
}

DELETE

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

Header Name	Example
`transId`	`"consequat in proident magna nostrud"`
`transactionSrc`	`"sint ad nostrud ullamco"`
`Prn`	`"voluptate nulla exercitation"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "002",
      "Description": "Completed"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "2",
          "Description": "Regional delay expected"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "jmw7jWXLYH"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ag0x4",
        "message": "Authentication failed"
      },
      {
        "code": "y7YlU",
        "message": "Authentication failed"
      },
      {
        "code": "SYs3x",
        "message": "Authentication failed"
      },
      {
        "code": "gBEj6",
        "message": "Record not found"
      },
      {
        "code": "KyTh4",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "gmCiS",
        "message": "Authentication failed"
      },
      {
        "code": "tRFCd",
        "message": "Invalid request"
      },
      {
        "code": "1UzKN",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "B7b8b",
        "message": "Invalid request"
      },
      {
        "code": "iMLEb",
        "message": "Record not found"
      },
      {
        "code": "F7HfG",
        "message": "Authentication failed"
      },
      {
        "code": "6U4km",
        "message": "Invalid request"
      },
      {
        "code": "ynTqf",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "0Apni",
        "message": "Invalid request"
      },
      {
        "code": "5H0D5",
        "message": "Invalid request"
      },
      {
        "code": "OoaI7",
        "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`	`"veniam est labore"`
`transactionSrc`	`"tempor anim 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": "deerJhoTWCy",
    "RateResult": {
      "ChargeDetail": [
        {
          "ChargeAmount": "73.64@73",
          "ChargeCode": "S",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "50.34-50",
          "TaxAmount": "5.17/5.1"
        },
        {
          "ChargeAmount": "91.28-91",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "27.6+27.",
          "TaxAmount": "0.93/0.9"
        },
        {
          "ChargeAmount": "92.48 92",
          "ChargeCode": "S",
          "ChargeDescription": "BASE CHARGE",
          "IncentedAmount": "49.12_49",
          "TaxAmount": "6.43^6.4"
        },
        {
          "ChargeAmount": "61.01/61",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "41.81^41",
          "TaxAmount": "1.68-1.6"
        },
        {
          "ChargeAmount": "55.96-55",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "45.63+45",
          "TaxAmount": "7.53+7.5"
        }
      ],
      "CurrencyCode": "pro",
      "Disclaimer": {
        "Code": "03",
        "Description": "Taxes are included"
      },
      "GrandTotalOfAllCharge": "qui dolo",
      "GrandTotalOfAllIncentedCharge": "nulla de",
      "PreTaxTotalCharge": "mollit d",
      "PreTaxTotalIncentedCharge": "in",
      "RateType": "et",
      "TaxCharges": [
        {
          "MonetaryValue": "4.79-4.7",
          "Type": "PST"
        },
        {
          "MonetaryValue": "1.18=1.1",
          "Type": "PST"
        },
        {
          "MonetaryValue": "1.1-1.1+",
          "Type": "PST"
        }
      ],
      "TotalTax": "dolore i"
    },
    "RateStatus": {
      "Code": "03",
      "Description": "aliquip ex laborum"
    },
    "Response": {
      "Alert": [
        {
          "Code": "8",
          "Description": "Delivery date modified"
        },
        {
          "Code": "7",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "COYvqwniut"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "E",
      "SunWST": "a"
    },
    "WeekendServiceTerritoryIndicator": "E"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "dtRvD",
        "message": "Authentication failed"
      },
      {
        "code": "UOXsh",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "9p60h",
        "message": "Authentication failed"
      },
      {
        "code": "30QNn",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "bCBPJ",
        "message": "Invalid request"
      },
      {
        "code": "NoB2s",
        "message": "Record not found"
      },
      {
        "code": "9KeZe",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "h7DkA",
        "message": "Invalid request"
      },
      {
        "code": "XB7vZ",
        "message": "Record not found"
      },
      {
        "code": "WE4K0",
        "message": "Record not found"
      },
      {
        "code": "49iZF",
        "message": "Invalid request"
      }
    ]
  }
}

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

upslogisticsshippingpickupsupply-chain