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`	`"consequat sed"`
`transactionSrc`	`"irure"`

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": "26.63+26",
          "ChargeCode": "A",
          "ChargeDescription": "BASE CHARGE",
          "IncentedAmount": "88.23@88",
          "TaxAmount": "7.4/7.4-"
        },
        {
          "ChargeAmount": "37.38^37",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "65.22^65",
          "TaxAmount": "4.59+4.5"
        },
        {
          "ChargeAmount": "98.82+98",
          "ChargeCode": "A",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "75.83 75",
          "TaxAmount": "4.58/4.5"
        }
      ],
      "CurrencyCode": "BBD",
      "Disclaimer": {
        "Code": "04",
        "Description": "Additional duties may apply"
      },
      "GrandTotalOfAllCharge": "102.38 1",
      "GrandTotalOfAllIncentedCharge": "174.95",
      "PreTaxTotalCharge": "52 52+52",
      "PreTaxTotalIncentedCharge": "59.7",
      "RateType": "FD",
      "TaxCharges": [
        {
          "MonetaryValue": "3.22/3.2",
          "Type": "GST"
        },
        {
          "MonetaryValue": "4.14@4.1",
          "Type": "PST"
        },
        {
          "MonetaryValue": "4.64/4.6",
          "Type": "PST"
        },
        {
          "MonetaryValue": "2.34/2.3",
          "Type": "PST"
        }
      ],
      "TotalTax": "9.22/9.2"
    },
    "Response": {
      "Alert": [
        {
          "Code": "5",
          "Description": "Delivery date modified"
        },
        {
          "Code": "5",
          "Description": "Delivery date modified"
        },
        {
          "Code": "8",
          "Description": "Address verification required"
        },
        {
          "Code": "3",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "ehVuLw2Ab8"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "N",
      "SunWST": "N"
    },
    "WeekendServiceTerritoryIndicator": "N"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "TNeiK",
        "message": "Invalid request"
      },
      {
        "code": "wTT1h",
        "message": "Invalid request"
      },
      {
        "code": "8XmPb",
        "message": "Invalid request"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "7gmy3",
        "message": "Record not found"
      },
      {
        "code": "UC0VY",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "2I5av",
        "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`	`"Lorem in ut cupidatat ad"`
`transactionSrc`	`"ea ut anim consequat"`
`AccountNumber`*	`"non veniam ex"`

Request Payload

Response Payload

{
  "PickupPendingStatusResponse": {
    "PendingStatus": [
      {
        "BillingCode": "Ex",
        "ContactName": "in culpa reprehe",
        "GWNStatusCode": "do",
        "OnCallStatusCode": "min",
        "PickupStatusMessage": "exercitation elit veniam non nisi",
        "PickupType": "Du",
        "PRN": "ullamcomagn",
        "ReferenceNumber": "Lorem commodo in fugiat incidi",
        "ServiceDate": "ipsum ut"
      },
      {
        "BillingCode": "pa",
        "ContactName": "tempor",
        "GWNStatusCode": "ei",
        "OnCallStatusCode": "tem",
        "PickupStatusMessage": "minim in consequat",
        "PickupType": "id",
        "PRN": "Ut ut venia",
        "ReferenceNumber": "culpa ullamco dolore et",
        "ServiceDate": "ut anim "
      }
    ],
    "Response": {
      "Alert": [
        {
          "Code": "9",
          "Description": "Regional delay expected"
        },
        {
          "Code": "2",
          "Description": "Delivery date modified"
        },
        {
          "Code": "8",
          "Description": "Regional delay expected"
        },
        {
          "Code": "4",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "P6LrF1JCwq"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "1kt0C",
        "message": "Record not found"
      },
      {
        "code": "Jnwsf",
        "message": "Record not found"
      },
      {
        "code": "XfS8g",
        "message": "Invalid request"
      },
      {
        "code": "cFkHj",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "0teHs",
        "message": "Record not found"
      },
      {
        "code": "nLSVE",
        "message": "Authentication failed"
      }
    ]
  }
}

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

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

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`	`"ut cillum"`
`transactionSrc`	`"fugiat ex"`
`Prn`	`"nulla in sed eiusmod enim"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "003",
      "Description": "User Triggered"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "8",
          "Description": "Regional delay expected"
        },
        {
          "Code": "8",
          "Description": "Regional delay expected"
        },
        {
          "Code": "4",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "6jFVVfItX4"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "Ndamc",
        "message": "Authentication failed"
      },
      {
        "code": "D7io5",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "QPZ3U",
        "message": "Authentication failed"
      },
      {
        "code": "n2eNk",
        "message": "Authentication failed"
      },
      {
        "code": "kJYTf",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ZgXTQ",
        "message": "Record not found"
      },
      {
        "code": "VJzN0",
        "message": "Record not found"
      },
      {
        "code": "8YHCc",
        "message": "Authentication failed"
      },
      {
        "code": "N8fls",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "RdQeK",
        "message": "Authentication failed"
      },
      {
        "code": "99HRD",
        "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`	`"aliqua nulla sunt"`
`transactionSrc`	`"quis eu deserunt elit"`

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": "poYf1",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "LW0NS",
        "message": "Record not found"
      },
      {
        "code": "3o6wn",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "ihsVF",
        "message": "Authentication failed"
      },
      {
        "code": "4GpRb",
        "message": "Invalid request"
      },
      {
        "code": "5NY7A",
        "message": "Invalid request"
      },
      {
        "code": "1iTL9",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "hvSI8",
        "message": "Invalid request"
      },
      {
        "code": "n3xZO",
        "message": "Record not found"
      },
      {
        "code": "Dftfy",
        "message": "Record not found"
      },
      {
        "code": "Hhyl7",
        "message": "Invalid request"
      },
      {
        "code": "6TbCX",
        "message": "Invalid request"
      }
    ]
  }
}

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`*	`"voluptate in"`
`transactionSrc`*	`"irure"`

Request Payload

Response Payload

{
  "PickupGetPoliticalDivision1ListResponse": {
    "PoliticalDivision1": [
      "voluptate",
      "amet dolore aute",
      "sint Duis aute irure",
      "veniam minim consequat sit irure",
      "nisi"
    ],
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Address verification required"
        },
        {
          "Code": "9",
          "Description": "Delivery date modified"
        },
        {
          "Code": "1",
          "Description": "Delivery date modified"
        },
        {
          "Code": "2",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "QpFKjqNIz6"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "PsBW7",
        "message": "Invalid request"
      },
      {
        "code": "3wpvK",
        "message": "Invalid request"
      },
      {
        "code": "AFLIb",
        "message": "Invalid request"
      },
      {
        "code": "OeAGB",
        "message": "Invalid request"
      },
      {
        "code": "Ndufg",
        "message": "Authentication failed"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "qG1tm",
        "message": "Invalid request"
      },
      {
        "code": "enCdp",
        "message": "Record not found"
      },
      {
        "code": "OyJOE",
        "message": "Authentication failed"
      },
      {
        "code": "2kqsH",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "luZyP",
        "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`	`"dolor magna ad do"`
`transactionSrc`	`"magna"`

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": "Address verification required"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        },
        {
          "Code": "6",
          "Description": "Regional delay expected"
        },
        {
          "Code": "6",
          "Description": "Address verification required"
        },
        {
          "Code": "2",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "ayX5xVUfAR"
      }
    },
    "ServiceCenterLocation": {
      "DropOffFacilities": [
        {
          "Address": {
            "AddressLine": "consequat Ut et dolore",
            "City": "Ut minim ut amet voluptate",
            "CountryCode": "ex",
            "PostalCode": "quiexerc",
            "ResidentialIndicator": "n",
            "StateProvince": "l"
          },
          "Distance": {
            "UnitOfMeasurement": "do",
            "Value": "enim c"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "Ut dolor laborum qui",
                "Day": "tempor ea ",
                "EarliestDropOfforPickup": "do eiusmod",
                "LastDrop": "sed velit dolore nul",
                "LatestDropOfforPickup": "quis deser",
                "OpenHours": "id occaecatullamcosi",
                "PrepTime": "ea idanim aliquip ni"
              },
              {
                "CloseHours": "ad animelit incididu",
                "Day": "elittempor",
                "EarliestDropOfforPickup": "est utdolo",
                "LastDrop": "pariatur ea et Lorem",
                "LatestDropOfforPickup": "ut in dolo",
                "OpenHours": "ea velit commodo idL",
                "PrepTime": "nostrudlaborum nostr"
              },
              {
                "CloseHours": "nisi sint estvelit c",
                "Day": "enim eu si",
                "EarliestDropOfforPickup": "dolor eala",
                "LastDrop": "amet nulla exercitat",
                "LatestDropOfforPickup": "amet culpa",
                "OpenHours": "et reprehenderitcupi",
                "PrepTime": "ut pariaturamet labo"
              },
              {
                "CloseHours": "labore nostrud tempo",
                "Day": "ad nulla e",
                "EarliestDropOfforPickup": "amet ut fu",
                "LastDrop": "dolore Lorem laborum",
                "LatestDropOfforPickup": "dolor este",
                "OpenHours": "id irure ametenim ni",
                "PrepTime": "ex culpaeiusmodmolli"
              },
              {
                "CloseHours": "cupidatat ea adipisi",
                "Day": "laboris qu",
                "EarliestDropOfforPickup": "nonlaborum",
                "LastDrop": "consequat Ut laborum",
                "LatestDropOfforPickup": "anim essea",
                "OpenHours": "aliquip docommodo pr",
                "PrepTime": "laborum voluptateuto"
              }
            ]
          },
          "Fax": "aliquip ea",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "consectetur aliquip",
              "Locale": "eu la"
            }
          ],
          "Name": "in",
          "OriginOrDestination": "nisi voluptate",
          "Phone": "nulla est ",
          "SLIC": "con",
          "Timezone": "fug",
          "Type": "iru"
        }
      ],
      "PickupFacilities": {
        "Address": {
          "AddressLine": "ex nulla voluptate",
          "City": "commodo",
          "CountryCode": "de",
          "PostalCode": "labo",
          "ResidentialIndicator": "f",
          "StateProvince": "magna dolor adipisicin"
        },
        "AirportCode": "Exc",
        "FacilityTime": {
          "DayOfWeek": [
            {
              "CloseHours": "voluptatenulla Uteiu",
              "Day": "enim sit c",
              "EarliestDropOfforPickup": "ullamco co",
              "LastDrop": "veniam commodo molli",
              "LatestDropOfforPickup": "veniam lab",
              "OpenHours": "ipsum ullamcodolorut",
              "PrepTime": "elit velit exnisi es"
            },
            {
              "CloseHours": "laboris fugiat nostr",
              "Day": "ipsum sit ",
              "EarliestDropOfforPickup": "magna euan",
              "LastDrop": "Excepteurin in magna",
              "LatestDropOfforPickup": "proident e",
              "OpenHours": "voluptateDuis culpa ",
              "PrepTime": "cupidatatUt euproide"
            },
            {
              "CloseHours": "Duisproident ad culp",
              "Day": "quis in do",
              "EarliestDropOfforPickup": "culpaLorem",
              "LastDrop": "quis in Ut esseincid",
              "LatestDropOfforPickup": "laborum vo",
              "OpenHours": "deserunt laborum ut ",
              "PrepTime": "sed voluptatevelit u"
            },
            {
              "CloseHours": "aliquaexnon aliquip ",
              "Day": "aliquipfug",
              "EarliestDropOfforPickup": "ullamco eu",
              "LastDrop": "ametexercitation lab",
              "LatestDropOfforPickup": "Duis velit",
              "OpenHours": "ad ipsum labore sint",
              "PrepTime": "minim labore occaeca"
            }
          ]
        },
        "Fax": "sit labore",
        "Name": "minim ex",
        "Phone": "elit eiusm",
        "SLIC": "am",
        "SortCode": "su",
        "Timezone": "Duis cillum",
        "Type": "vel"
      }
    }
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "Nan4I",
        "message": "Invalid request"
      },
      {
        "code": "a2ihF",
        "message": "Invalid request"
      },
      {
        "code": "VAP0a",
        "message": "Authentication failed"
      },
      {
        "code": "ALejS",
        "message": "Record not found"
      },
      {
        "code": "elLF0",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "YhSdm",
        "message": "Invalid request"
      },
      {
        "code": "t0vVi",
        "message": "Record not found"
      },
      {
        "code": "Acn1i",
        "message": "Authentication failed"
      },
      {
        "code": "oYt3J",
        "message": "Authentication failed"
      },
      {
        "code": "yV3NQ",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "uADTJ",
        "message": "Authentication failed"
      },
      {
        "code": "nG7SQ",
        "message": "Record not found"
      },
      {
        "code": "mBFjH",
        "message": "Authentication failed"
      },
      {
        "code": "feD1W",
        "message": "Invalid request"
      }
    ]
  }
}

DELETE

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

Header Name	Example
`transId`	`"voluptate aute magna enim"`
`transactionSrc`	`"esse consectetur do"`
`Prn`	`"reprehenderit"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "001",
      "Description": "User Triggered"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Address verification required"
        },
        {
          "Code": "5",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "6AUsrg6wZC"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4WVlE",
        "message": "Authentication failed"
      },
      {
        "code": "4hpp4",
        "message": "Invalid request"
      },
      {
        "code": "4HhcH",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "OJlYn",
        "message": "Authentication failed"
      },
      {
        "code": "Wy7p3",
        "message": "Invalid request"
      },
      {
        "code": "K2Zs7",
        "message": "Authentication failed"
      },
      {
        "code": "mycc1",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "gyUl4",
        "message": "Authentication failed"
      },
      {
        "code": "Rol1S",
        "message": "Record not found"
      },
      {
        "code": "siOtt",
        "message": "Invalid request"
      },
      {
        "code": "6kqNg",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "SGoIt",
        "message": "Authentication failed"
      },
      {
        "code": "Lt877",
        "message": "Invalid request"
      },
      {
        "code": "yV2D2",
        "message": "Record not found"
      }
    ]
  }
}

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`	`"dolore enim veniam commodo"`
`transactionSrc`	`"et enim"`

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": "5ctWdTK46kz",
    "RateResult": {
      "ChargeDetail": [
        {
          "ChargeAmount": "13.68+13",
          "ChargeCode": "S",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "21.78_21",
          "TaxAmount": "6.08=6.0"
        }
      ],
      "CurrencyCode": "off",
      "Disclaimer": {
        "Code": "04",
        "Description": "Additional duties may apply"
      },
      "GrandTotalOfAllCharge": "sint id ",
      "GrandTotalOfAllIncentedCharge": "laboru",
      "PreTaxTotalCharge": "dolor Ex",
      "PreTaxTotalIncentedCharge": "ut",
      "RateType": "pa",
      "TaxCharges": [
        {
          "MonetaryValue": "1.81+1.8",
          "Type": "PST"
        },
        {
          "MonetaryValue": "3.24@3.2",
          "Type": "PST"
        },
        {
          "MonetaryValue": "3.81 3.8",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "2.17-2.1",
          "Type": "VAT"
        },
        {
          "MonetaryValue": "3.57=3.5",
          "Type": "GST"
        }
      ],
      "TotalTax": "sunt con"
    },
    "RateStatus": {
      "Code": "02",
      "Description": "in qui"
    },
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Regional delay expected"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        },
        {
          "Code": "0",
          "Description": "Regional delay expected"
        },
        {
          "Code": "5",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "mVTyK5nKlJ"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "v",
      "SunWST": "c"
    },
    "WeekendServiceTerritoryIndicator": "d"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "opOzF",
        "message": "Invalid request"
      },
      {
        "code": "zm7qr",
        "message": "Invalid request"
      },
      {
        "code": "m4kjT",
        "message": "Invalid request"
      },
      {
        "code": "5EUtN",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "GTcPC",
        "message": "Record not found"
      },
      {
        "code": "5PfBp",
        "message": "Invalid request"
      },
      {
        "code": "WKzwv",
        "message": "Invalid request"
      },
      {
        "code": "boz7j",
        "message": "Authentication failed"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "4I0Cg",
        "message": "Authentication failed"
      },
      {
        "code": "bA7ik",
        "message": "Record not found"
      }
    ]
  }
}

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

upslogisticsshippingpickupsupply-chain