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`	`"in eiusmod"`
`transactionSrc`	`"dolore aliquip esse"`

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": "28.67_28",
          "ChargeCode": "B",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "78.72-78",
          "TaxAmount": "4.98 4.9"
        }
      ],
      "CurrencyCode": "TWD",
      "Disclaimer": {
        "Code": "03",
        "Description": "Additional duties may apply"
      },
      "GrandTotalOfAllCharge": "124.3_12",
      "GrandTotalOfAllIncentedCharge": "28.59",
      "PreTaxTotalCharge": "170.58/1",
      "PreTaxTotalIncentedCharge": "108.71",
      "RateType": "FD",
      "TaxCharges": [
        {
          "MonetaryValue": "2.12_2.1",
          "Type": "GST"
        },
        {
          "MonetaryValue": "3.31^3.3",
          "Type": "GST"
        },
        {
          "MonetaryValue": "2.47=2.4",
          "Type": "GST"
        }
      ],
      "TotalTax": "10.18 10"
    },
    "Response": {
      "Alert": [
        {
          "Code": "8",
          "Description": "Regional delay expected"
        },
        {
          "Code": "0",
          "Description": "Delivery date modified"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        },
        {
          "Code": "1",
          "Description": "Delivery date modified"
        },
        {
          "Code": "7",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "vBj04zyoKC"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "Y",
      "SunWST": "N"
    },
    "WeekendServiceTerritoryIndicator": "Y"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "lbdXc",
        "message": "Invalid request"
      },
      {
        "code": "CRCWh",
        "message": "Invalid request"
      },
      {
        "code": "Awahw",
        "message": "Invalid request"
      },
      {
        "code": "l2Buy",
        "message": "Invalid request"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "FtZwB",
        "message": "Record not found"
      },
      {
        "code": "D7WZV",
        "message": "Invalid request"
      },
      {
        "code": "zKW8o",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "GAxzC",
        "message": "Authentication failed"
      },
      {
        "code": "QmzvD",
        "message": "Invalid request"
      },
      {
        "code": "1AH3P",
        "message": "Invalid request"
      }
    ]
  }
}

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`	`"et"`
`transactionSrc`	`"labore officia tempor"`
`AccountNumber`*	`"labore"`

Request Payload

Response Payload

{
  "PickupPendingStatusResponse": {
    "PendingStatus": [
      {
        "BillingCode": "nu",
        "ContactName": "in mol",
        "GWNStatusCode": "cu",
        "OnCallStatusCode": "ali",
        "PickupStatusMessage": "in non",
        "PickupType": "pa",
        "PRN": "laboris eiu",
        "ReferenceNumber": "adipis",
        "ServiceDate": "dolore a"
      },
      {
        "BillingCode": "au",
        "ContactName": "consequ",
        "GWNStatusCode": "en",
        "OnCallStatusCode": "rep",
        "PickupStatusMessage": "dolor in ut",
        "PickupType": "ex",
        "PRN": "non sed eli",
        "ReferenceNumber": "sit exerci",
        "ServiceDate": "sunt eni"
      }
    ],
    "Response": {
      "Alert": [
        {
          "Code": "8",
          "Description": "Delivery date modified"
        },
        {
          "Code": "7",
          "Description": "Regional delay expected"
        },
        {
          "Code": "1",
          "Description": "Regional delay expected"
        },
        {
          "Code": "9",
          "Description": "Regional delay expected"
        },
        {
          "Code": "1",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "x5ZyREemJe"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "DP2IA",
        "message": "Invalid request"
      },
      {
        "code": "in9JO",
        "message": "Invalid request"
      },
      {
        "code": "3ZBwr",
        "message": "Record not found"
      },
      {
        "code": "B05Di",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "st8wF",
        "message": "Invalid request"
      },
      {
        "code": "64Gzi",
        "message": "Record not found"
      },
      {
        "code": "0dXAx",
        "message": "Record not found"
      },
      {
        "code": "rRO0h",
        "message": "Invalid request"
      },
      {
        "code": "V0hZy",
        "message": "Authentication failed"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "G0bAy",
        "message": "Record not found"
      },
      {
        "code": "24OJy",
        "message": "Authentication failed"
      },
      {
        "code": "XxKhz",
        "message": "Invalid request"
      },
      {
        "code": "6yLjs",
        "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`	`"elit"`
`transactionSrc`	`"pariatur nisi irure"`
`Prn`	`"non mollit nostrud do"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "007",
      "Description": "Completed"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "0",
          "Description": "Address verification required"
        },
        {
          "Code": "3",
          "Description": "Regional delay expected"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "orgykLZ0d6"
      }
    }
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "Z00Rg",
        "message": "Record not found"
      },
      {
        "code": "TqXoE",
        "message": "Invalid request"
      },
      {
        "code": "dWy6O",
        "message": "Authentication failed"
      },
      {
        "code": "PgsZU",
        "message": "Authentication failed"
      },
      {
        "code": "vJDfw",
        "message": "Authentication failed"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "JH8bH",
        "message": "Invalid request"
      },
      {
        "code": "7sOpi",
        "message": "Authentication failed"
      },
      {
        "code": "iyBRV",
        "message": "Record not found"
      },
      {
        "code": "LCJS0",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "EgB2P",
        "message": "Record not found"
      },
      {
        "code": "c78VB",
        "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`	`"cupidatat nulla adipisicing ad"`
`transactionSrc`	`"non"`

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": "6STQb",
        "message": "Invalid request"
      },
      {
        "code": "u60Js",
        "message": "Record not found"
      },
      {
        "code": "gcJAS",
        "message": "Invalid request"
      },
      {
        "code": "yL70z",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "OsFLa",
        "message": "Record not found"
      },
      {
        "code": "9z8uC",
        "message": "Record not found"
      }
    ]
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "s9nkp",
        "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`*	`"cupidatat elit"`
`transactionSrc`*	`"deserunt voluptate"`

Request Payload

Response Payload

{
  "PickupGetPoliticalDivision1ListResponse": {
    "PoliticalDivision1": [
      "deserunt nisi",
      "minim consectetur laboris veniam dolore",
      "culpa ipsum proident aute reprehenderit",
      "consequat",
      "sed cillum consequat"
    ],
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "4b9z4Tk7ol"
      }
    }
  }
}

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

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

{
  "response": {
    "errors": [
      {
        "code": "UDZor",
        "message": "Record not found"
      },
      {
        "code": "VY4en",
        "message": "Authentication failed"
      },
      {
        "code": "2GoAr",
        "message": "Authentication failed"
      },
      {
        "code": "4IWO7",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "00OEi",
        "message": "Record not found"
      },
      {
        "code": "VUiH8",
        "message": "Authentication failed"
      },
      {
        "code": "JTyaI",
        "message": "Record not found"
      },
      {
        "code": "3BKc3",
        "message": "Authentication failed"
      }
    ]
  }
}

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`	`"aliqua Lorem reprehenderit exercitation"`
`transactionSrc`	`"ut in"`

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": "6",
          "Description": "Address verification required"
        },
        {
          "Code": "2",
          "Description": "Regional delay expected"
        },
        {
          "Code": "8",
          "Description": "Address verification required"
        },
        {
          "Code": "8",
          "Description": "Delivery date modified"
        },
        {
          "Code": "7",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "96DiiBGRCL"
      }
    },
    "ServiceCenterLocation": {
      "DropOffFacilities": [
        {
          "Address": {
            "AddressLine": [
              "esse Duis in commodo",
              "proident dolore enim",
              "laborum sed Ut officia",
              "do voluptate in",
              "minim et Lorem ipsum consequat"
            ],
            "City": "sed",
            "CountryCode": "p",
            "PostalCode": "id Excep",
            "ResidentialIndicator": "c",
            "StateProvince": "voluptate aliquip"
          },
          "Distance": {
            "UnitOfMeasurement": "qu",
            "Value": "pariat"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "exercitation enim id",
                "Day": "pariatur l",
                "EarliestDropOfforPickup": "nostrud ut",
                "LastDrop": "consecteturnisidolor",
                "LatestDropOfforPickup": "aliqua com",
                "OpenHours": "labore veniam ipsum ",
                "PrepTime": "tempor doveniam elit"
              }
            ]
          },
          "Fax": "incididunt",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "sit aliqua",
              "Locale": "exerc"
            },
            {
              "Last50ftInstruction": "in consectetur veniam aliqua",
              "Locale": "sit c"
            },
            {
              "Last50ftInstruction": "in ea co",
              "Locale": "commo"
            }
          ],
          "Name": "Duis enim laborum anim",
          "OriginOrDestination": "id amet",
          "Phone": "elitutsunt",
          "SLIC": "labor",
          "Timezone": "inci",
          "Type": "ess"
        },
        {
          "Address": {
            "AddressLine": "fugiat est cupidatat sunt nostrud",
            "City": "cillum adipisicing sed exercitation cul",
            "CountryCode": "de",
            "PostalCode": "dolore a",
            "ResidentialIndicator": "n",
            "StateProvince": "id Excepteur"
          },
          "Distance": {
            "UnitOfMeasurement": "la",
            "Value": "dolore"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "esse in consequat id",
                "Day": "aliquip Ut",
                "EarliestDropOfforPickup": "mollit ea ",
                "LastDrop": "voluptateexercitatio",
                "LatestDropOfforPickup": "deserunt d",
                "OpenHours": "adipisicing temporan",
                "PrepTime": "doloresitipsumrepreh"
              },
              {
                "CloseHours": "amet dolorestinculpa",
                "Day": "nonirure p",
                "EarliestDropOfforPickup": "magna sunt",
                "LastDrop": "ullamco ex est irure",
                "LatestDropOfforPickup": "laboris si",
                "OpenHours": "velit ipsum cupidata",
                "PrepTime": "tempor etcupidatat a"
              },
              {
                "CloseHours": "laboris anim reprehe",
                "Day": "dolor non ",
                "EarliestDropOfforPickup": "et dolor s",
                "LastDrop": "mollit consectetur d",
                "LatestDropOfforPickup": "nulla in l",
                "OpenHours": "officia tempor ut et",
                "PrepTime": "deseruntreprehenderi"
              },
              {
                "CloseHours": "non Excepteur ad idc",
                "Day": "ea dolore ",
                "EarliestDropOfforPickup": "dolor inci",
                "LastDrop": "indolorirure laboris",
                "LatestDropOfforPickup": "adipisicin",
                "OpenHours": "deseruntipsum magna ",
                "PrepTime": "velitesseproident ex"
              },
              {
                "CloseHours": "sunt aliquip exercit",
                "Day": "domagna in",
                "EarliestDropOfforPickup": "nulla cill",
                "LastDrop": "dolor proident eupro",
                "LatestDropOfforPickup": "magna cill",
                "OpenHours": "consectetur Lorem do",
                "PrepTime": "inDuis suntconsequat"
              }
            ]
          },
          "Fax": "pariatur n",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "Duis quis",
              "Locale": "dolor"
            },
            {
              "Last50ftInstruction": "aliqua",
              "Locale": "aute "
            }
          ],
          "Name": "et aliqua",
          "OriginOrDestination": "irure do",
          "Phone": "eiusmod co",
          "SLIC": "pari",
          "Timezone": "sit aliqua sunt i",
          "Type": "iru"
        },
        {
          "Address": {
            "AddressLine": [
              "reprehenderit ullamco",
              "nisi ex"
            ],
            "City": "Duis proident do u",
            "CountryCode": "d",
            "PostalCode": "reprehen",
            "ResidentialIndicator": "s",
            "StateProvince": "sunt aliquip cupidatat"
          },
          "Distance": {
            "UnitOfMeasurement": "ex",
            "Value": "Duisin"
          },
          "FacilityTime": {
            "DayOfWeek": [
              {
                "CloseHours": "nostrud utipsum eius",
                "Day": "tempor lab",
                "EarliestDropOfforPickup": "velit aliq",
                "LastDrop": "enimvelit pariatur m",
                "LatestDropOfforPickup": "qui non do",
                "OpenHours": "voluptate adipisicin",
                "PrepTime": "nulla qui deseruntco"
              }
            ]
          },
          "Fax": "sed ametip",
          "LocalizedInstruction": [
            {
              "Last50ftInstruction": "in sunt Duis anim ut",
              "Locale": "ullam"
            }
          ],
          "Name": "aliqua in ullamco nulla",
          "OriginOrDestination": "esse",
          "Phone": "quis idcul",
          "SLIC": "c",
          "Timezone": "te",
          "Type": "aut"
        }
      ],
      "PickupFacilities": {
        "Address": {
          "AddressLine": "qui pariatur do",
          "City": "magna Ut ad",
          "CountryCode": "co",
          "PostalCode": "sed al",
          "ResidentialIndicator": "a",
          "StateProvince": "proident tempor in dolore dolor"
        },
        "AirportCode": "lab",
        "FacilityTime": {
          "DayOfWeek": [
            {
              "CloseHours": "estad consequat insu",
              "Day": "ipsum Duis",
              "EarliestDropOfforPickup": "ullamco vo",
              "LastDrop": "do velit officia ali",
              "LatestDropOfforPickup": "cupidatat ",
              "OpenHours": "quisfugiatdolore Dui",
              "PrepTime": "velitincididunt elit"
            },
            {
              "CloseHours": "ut in ullamcominimut",
              "Day": "cupidatat ",
              "EarliestDropOfforPickup": "pariatur e",
              "LastDrop": "sintelit sunt esse n",
              "LatestDropOfforPickup": "Ut doloreu",
              "OpenHours": "sit laborisirure des",
              "PrepTime": "proidentoccaecat ali"
            }
          ]
        },
        "Fax": "incididunt",
        "Name": "esse",
        "Phone": "in consequ",
        "SLIC": "i",
        "SortCode": "id",
        "Timezone": "deserunt c",
        "Type": "mol"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "rUHUH",
        "message": "Invalid request"
      },
      {
        "code": "7CmRQ",
        "message": "Record not found"
      },
      {
        "code": "6cvYg",
        "message": "Record not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "qusnV",
        "message": "Authentication failed"
      },
      {
        "code": "GLlFc",
        "message": "Authentication failed"
      },
      {
        "code": "y7JHv",
        "message": "Authentication failed"
      },
      {
        "code": "xR9px",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4eSwv",
        "message": "Authentication failed"
      },
      {
        "code": "WQ93I",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "plkDo",
        "message": "Invalid request"
      },
      {
        "code": "DowhP",
        "message": "Invalid request"
      },
      {
        "code": "6hQo9",
        "message": "Record not found"
      },
      {
        "code": "GPKt8",
        "message": "Authentication failed"
      },
      {
        "code": "bSoLr",
        "message": "Invalid request"
      }
    ]
  }
}

DELETE

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

Header Name	Example
`transId`	`"amet sed deserunt nulla sint"`
`transactionSrc`	`"Lorem nostrud sunt irure in"`
`Prn`	`"occaecat ad ex"`

Request Payload

Response Payload

{
  "PickupCancelResponse": {
    "GWNStatus": {
      "Code": "001",
      "Description": "User Cancelled"
    },
    "PickupType": "01",
    "Response": {
      "Alert": [
        {
          "Code": "2",
          "Description": "Delivery date modified"
        },
        {
          "Code": "0",
          "Description": "Delivery date modified"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failed"
      },
      "TransactionReference": {
        "CustomerContext": "rIHFRL8IYI"
      }
    }
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "7Sx9j",
        "message": "Invalid request"
      },
      {
        "code": "6G1xP",
        "message": "Invalid request"
      },
      {
        "code": "qoAjX",
        "message": "Invalid request"
      }
    ]
  }
}

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

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

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`	`"exercitation est eu sint"`
`transactionSrc`	`"laborum dolor 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": "8j7FPzLd9Kk",
    "RateResult": {
      "ChargeDetail": [
        {
          "ChargeAmount": "25.54=25",
          "ChargeCode": "S",
          "ChargeDescription": "RESIDENTIAL SURCHARGE",
          "IncentedAmount": "18.6 18.",
          "TaxAmount": "1.32@1.3"
        }
      ],
      "CurrencyCode": "do ",
      "Disclaimer": {
        "Code": "04",
        "Description": "Additional duties may apply"
      },
      "GrandTotalOfAllCharge": "consequa",
      "GrandTotalOfAllIncentedCharge": "nulla",
      "PreTaxTotalCharge": "ut irure",
      "PreTaxTotalIncentedCharge": "Duis i",
      "RateType": "ul",
      "TaxCharges": [
        {
          "MonetaryValue": "3.47_3.4",
          "Type": "GST"
        }
      ],
      "TotalTax": "tempor f"
    },
    "RateStatus": {
      "Code": "02",
      "Description": "reprehende"
    },
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Address verification required"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        },
        {
          "Code": "8",
          "Description": "Delivery date modified"
        },
        {
          "Code": "3",
          "Description": "Address verification required"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "Eu7dEbEc6j"
      }
    },
    "WeekendServiceTerritory": {
      "SatWST": "i",
      "SunWST": "s"
    },
    "WeekendServiceTerritoryIndicator": "m"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "y1nVk",
        "message": "Record not found"
      },
      {
        "code": "X8oIx",
        "message": "Authentication failed"
      },
      {
        "code": "gegrb",
        "message": "Record not found"
      }
    ]
  }
}

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

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

{
  "response": {
    "errors": [
      {
        "code": "Lwy08",
        "message": "Record not found"
      },
      {
        "code": "FRxtu",
        "message": "Record not found"
      },
      {
        "code": "G9xyK",
        "message": "Authentication failed"
      },
      {
        "code": "211Xh",
        "message": "Invalid request"
      },
      {
        "code": "o1OdV",
        "message": "Record not found"
      }
    ]
  }
}

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

upslogisticsshippingpickupsupply-chain