UPS Shipping Virtual Sandbox
Manage package shipments, label generation, and voiding operations.
The UPS Shipping API provides developers with tools to manage the end-to-end shipment lifecycle. It supports creating shipping requests, generating labels, and handling shipment cancellations or voids. This service is essential for integrating logistics, tracking, and fulfillment workflows into e-commerce and supply chain applications.
Use this hosted sandbox to simulate UPS Shipping 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 shipping request payloads, label generation formats, shipment voiding logic, and error handling for invalid addresses or service codes before integrating with UPS production logistics systems.
Shipping(5 operations)
POST
| Query Parameter Name | Example |
|---|---|
additionaladdressvalidation | nostrud mollit et est |
| Header Name | Example |
|---|---|
transId | "adipisicing esse" |
transactionSrc | "ipsum" |
{
"ShipmentRequest": {
"Request": {
"SubVersion": "1801",
"RequestOption": "nonvalidate",
"TransactionReference": {
"CustomerContext": ""
}
},
"Shipment": {
"Description": "Ship WS test",
"Shipper": {
"Name": "ShipperName",
"AttentionName": "ShipperZs Attn Name",
"TaxIdentificationNumber": "123456",
"Phone": {
"Number": "1115554758",
"Extension": " "
},
"ShipperNumber": " ",
"FaxNumber": "8002222222",
"Address": {
"AddressLine": [
"2311 York Rd"
],
"City": "Timonium",
"StateProvinceCode": "MD",
"PostalCode": "21093",
"CountryCode": "US"
}
},
"ShipTo": {
"Name": "Happy Dog Pet Supply",
"AttentionName": "1160b_74",
"Phone": {
"Number": "9225377171"
},
"Address": {
"AddressLine": [
"123 Main St"
],
"City": "timonium",
"StateProvinceCode": "MD",
"PostalCode": "21030",
"CountryCode": "US"
},
"Residential": " "
},
"ShipFrom": {
"Name": "T and T Designs",
"AttentionName": "1160b_74",
"Phone": {
"Number": "1234567890"
},
"FaxNumber": "1234567890",
"Address": {
"AddressLine": [
"2311 York Rd"
],
"City": "Alpharetta",
"StateProvinceCode": "GA",
"PostalCode": "30005",
"CountryCode": "US"
}
},
"PaymentInformation": {
"ShipmentCharge": {
"Type": "01",
"BillShipper": {
"AccountNumber": " "
}
}
},
"Service": {
"Code": "03",
"Description": "Express"
},
"Package": {
"Description": " ",
"Packaging": {
"Code": "02",
"Description": "Nails"
},
"Dimensions": {
"UnitOfMeasurement": {
"Code": "IN",
"Description": "Inches"
},
"Length": "10",
"Width": "30",
"Height": "45"
},
"PackageWeight": {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "Pounds"
},
"Weight": "5"
}
}
},
"LabelSpecification": {
"LabelImageFormat": {
"Code": "GIF",
"Description": "GIF"
},
"HTTPUserAgent": "Mozilla/4.5"
}
}
}{
"ShipmentResponse": {
"Response": {
"Alert": [
{
"Code": "laboris ",
"Description": "Duis dolore eu dolor occaecat"
},
{
"Code": "nisi ",
"Description": "co"
}
],
"ResponseStatus": {
"Code": "l",
"Description": "aute ex"
},
"TransactionReference": {
"CustomerContext": "eiusmod est id sit fugiat"
}
},
"ShipmentResults": {
"BarCodeImage": "nisi amet mollit nulla",
"BillableWeightCalculationMethod": "qu",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "do ",
"Description": "ad elit eu officia"
},
"Weight": "in conse"
},
"BillOfLading": "voluptate dolore officia nostrud amet",
"CODTurnInPage": {
"Image": {
"GraphicImage": "ea nostrud",
"ImageFormat": {
"Code": "in ",
"Description": "consectetu"
}
}
},
"ControlLogReceipt": [
{
"GraphicImage": "dolore consequat",
"ImageFormat": {
"Code": "enim",
"Description": "est fugiat occaecat nostru"
}
},
{
"GraphicImage": "dolor id",
"ImageFormat": {
"Code": "ulla",
"Description": "elit veniam"
}
}
],
"DGPaperImage": [
"magna voluptate",
"non laborum aliquip ut",
"ad commodo tempor reprehenderit"
],
"Disclaimer": [
{
"Code": "ut",
"Description": "deserunt"
}
],
"Form": {
"Code": "c",
"Description": "in",
"FormGroupId": "nostrud minim",
"FormGroupIdName": "Lorem d",
"Image": {
"GraphicImage": "esse aute exercitation",
"ImageFormat": {
"Code": "con",
"Description": "aliqua qui"
}
}
},
"FRSShipmentData": {
"FreightDensityRate": {
"Density": "eu u",
"TotalCubicFeet": "dolore"
},
"HandlingUnits": [
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "ad",
"Description": "magna ad ullamco v"
},
"Value": "aute incididu"
},
"Dimensions": {
"Height": "Excepteur",
"Length": "of",
"UnitOfMeasurement": {
"Code": "pr",
"Description": "anim velit id ad in"
},
"Width": "anim"
},
"Quantity": "minim se",
"Type": {
"Code": "cul",
"Description": "d"
}
},
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "do",
"Description": "sint"
},
"Value": "qui sunt inci"
},
"Dimensions": {
"Height": "aute",
"Length": "sunt a",
"UnitOfMeasurement": {
"Code": "ut",
"Description": "ad incididu"
},
"Width": "sed null"
},
"Quantity": "cupid",
"Type": {
"Code": "occ",
"Description": "exercitation velit eu"
}
}
],
"TransportationCharges": {
"DiscountAmount": {
"CurrencyCode": "iru",
"MonetaryValue": "U"
},
"DiscountPercentage": "sed",
"GrossCharge": {
"CurrencyCode": "sed",
"MonetaryValue": "reprehenderi"
},
"NetCharge": {
"CurrencyCode": "com",
"MonetaryValue": "elit occaeca"
}
}
},
"GCCN": "elit eu",
"HighValueReport": {
"Image": {
"GraphicImage": "dolor adipisicing dolore occaecat",
"ImageFormat": {
"Code": "par",
"Description": "sint Excepteur irure"
}
}
},
"LabelURL": "et sint ullamco",
"LocalLanguageLabelURL": "proident in et do sit",
"LocalLanguageReceiptURL": "cillum nulla sit veniam",
"MasterCartonID": "in",
"Message": "est",
"MIDualReturnShipmentKey": "aliqua Ut tempor cillum inc",
"NegotiatedRateCharges": {
"ItemizedCharges": [
{
"Code": "id ",
"CurrencyCode": "ips",
"Description": "reprehend",
"MonetaryValue": "enim in amet",
"SubType": "sed in dolore"
},
{
"Code": "Exc",
"CurrencyCode": "dol",
"Description": "dolor aliquip",
"MonetaryValue": "ipsum",
"SubType": "in"
}
],
"RateModifier": [
{
"Amount": "cillum pariatur ",
"ModifierDesc": "cupidatat ullamco sed reprehenderit proidentdo occ",
"ModifierType": "qui"
},
{
"Amount": "sed reprehenderi",
"ModifierDesc": "magna officia proident consecteturadipisicing moll",
"ModifierType": "fug"
}
],
"TaxCharges": [
{
"MonetaryValue": "dolore vel",
"Type": "anim l"
},
{
"MonetaryValue": "proident est dolo",
"Type": "ips"
},
{
"MonetaryValue": "do",
"Type": "mi"
},
{
"MonetaryValue": "ea do dolor pa",
"Type": "fugi"
}
],
"TotalCharge": {
"CurrencyCode": "qui",
"MonetaryValue": "ut"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "com",
"MonetaryValue": "a"
}
},
"PackageResults": [
{
"Accessorial": [
{
"Code": "rep",
"Description": "sint proident"
},
{
"Code": "ut ",
"Description": "culpa"
}
],
"BaseServiceCharge": {
"CurrencyCode": "qui",
"MonetaryValue": "irur"
},
"CN22Number": "dolor proident",
"Form": {
"Code": "co",
"Description": "pariatur tempor",
"FormGroupId": "irure labore velit in ",
"FormGroupIdName": "officia non ei",
"Image": {
"GraphicImage": "id consectetur dolore",
"ImageFormat": {
"Code": "aut",
"Description": "laborum i"
}
}
},
"ItemizedCharges": [
{
"Code": "mol",
"CurrencyCode": "eli",
"Description": "Ut ullamco deserunt eius",
"MonetaryValue": "ut vo",
"SubType": "commodo sunt"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "sun",
"CurrencyCode": "qui",
"Description": "sint voluptate",
"MonetaryValue": "culpa mollit cons",
"SubType": "quis enim"
},
{
"Code": "off",
"CurrencyCode": "mag",
"Description": "est do ",
"MonetaryValue": "consectetur ",
"SubType": "amet veniam"
},
{
"Code": "lab",
"CurrencyCode": "fug",
"Description": "occaecat v",
"MonetaryValue": "Lorem occa",
"SubType": "aliqua sint occaecat ut"
}
],
"RateModifier": [
{
"Amount": "amet id exercita",
"ModifierDesc": "culpa eu exercitation nulla auteadipisicinganim oc",
"ModifierType": "exe"
}
]
},
"RateModifier": [
{
"Amount": "occaecat dolor",
"ModifierDesc": "occaecat",
"ModifierType": "ven"
},
{
"Amount": "aliquip ",
"ModifierDesc": "ea nulla",
"ModifierType": "iru"
},
{
"Amount": "ipsum id",
"ModifierDesc": "nostrud",
"ModifierType": "off"
},
{
"Amount": "cupidatat nu",
"ModifierDesc": "eiusmod id",
"ModifierType": "nos"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "off",
"MonetaryValue": "irure consec"
},
"ShippingLabel": {
"GraphicImage": "aute do anim",
"GraphicImagePart": [
"anim tempor",
"cupidatat dolor",
"reprehenderit culpa elit velit aliqua",
"ea eiusmod minim ut qui"
],
"HTMLImage": "quis do",
"ImageFormat": {
"Code": "Dui",
"Description": "v"
},
"InternationalSignatureGraphicImage": "Duis in nulla cupidatat ullamco",
"PDF417": "dolor"
},
"ShippingReceipt": {
"GraphicImage": "dolor",
"ImageFormat": {
"Code": "cupi",
"Description": "amet aliquip dolor"
}
},
"SimpleRate": {
"Code": "cu"
},
"TrackingNumber": "voluptate adipisic",
"USPSPICNumber": "dolore dolor in eu"
},
{
"Accessorial": [
{
"Code": "ali",
"Description": "deserunt qui ullamco incididunt ea"
},
{
"Code": "ven",
"Description": "consequat ut"
},
{
"Code": "min",
"Description": "officia sit pariatu"
},
{
"Code": "Exc",
"Description": "ea et"
}
],
"BaseServiceCharge": {
"CurrencyCode": "des",
"MonetaryValue": "incid"
},
"CN22Number": "fugiat in officia reprehenderit Duis",
"Form": {
"Code": "ut",
"Description": "labore",
"FormGroupId": "occaecat n",
"FormGroupIdName": "dolor eu",
"Image": {
"GraphicImage": "eu exercitation elit",
"ImageFormat": {
"Code": "exe",
"Description": "Lor"
}
}
},
"ItemizedCharges": [
{
"Code": "ess",
"CurrencyCode": "est",
"Description": "minim Excepteur",
"MonetaryValue": "aliquip se",
"SubType": "velit occaecat"
},
{
"Code": "inc",
"CurrencyCode": "nis",
"Description": "culpa aute",
"MonetaryValue": "aliq",
"SubType": "quis nulla "
},
{
"Code": "est",
"CurrencyCode": "eiu",
"Description": "cillum eu commodo ut",
"MonetaryValue": "sit fugiat mollit",
"SubType": "incididunt ullamco eni"
},
{
"Code": "com",
"CurrencyCode": "non",
"Description": "dolore commodo",
"MonetaryValue": "in",
"SubType": "min"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "Dui",
"CurrencyCode": "ani",
"Description": "quis ex sed",
"MonetaryValue": "laboris sit",
"SubType": "eu"
}
],
"RateModifier": [
{
"Amount": "magnaexercitatio",
"ModifierDesc": "esse dolor Lorem magnasunt incididunt eaametamet s",
"ModifierType": "par"
}
]
},
"RateModifier": [
{
"Amount": "ex",
"ModifierDesc": "veniam officia",
"ModifierType": "Exc"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "in ",
"MonetaryValue": "qu"
},
"ShippingLabel": {
"GraphicImage": "eiusmod irure ut minim",
"GraphicImagePart": [
"esse"
],
"HTMLImage": "in laboris deserunt esse",
"ImageFormat": {
"Code": "mag",
"Description": "in et paria"
},
"InternationalSignatureGraphicImage": "veniam exercitation aliquip",
"PDF417": "id proident"
},
"ShippingReceipt": {
"GraphicImage": "in aliquip",
"ImageFormat": {
"Code": "inc",
"Description": "ullamco "
}
},
"SimpleRate": {
"Code": "ad"
},
"TrackingNumber": "labore qui dolore ",
"USPSPICNumber": "ad sunt Ut"
}
],
"PalletLabel": {
"PalletLabel": "occaecat cupidatat velit sint tempor"
},
"RatingMethod": "in",
"ReceiptURL": "aliquip dolore minim enim",
"RoarRatedIndicator": "consequat dolor sit mollit",
"ShipmentCharges": {
"BaseServiceCharge": {
"CurrencyCode": "con",
"MonetaryValue": "ut cupidatat lab"
},
"ItemizedCharges": [
{
"Code": "adi",
"CurrencyCode": "in ",
"Description": "et dolor e",
"MonetaryValue": "labore nulla c",
"SubType": "ex aliquip eli"
}
],
"RateChart": "f",
"ServiceOptionsCharges": {
"CurrencyCode": "ven",
"MonetaryValue": "Duis ut nisi nulla"
},
"TaxCharges": [
{
"MonetaryValue": "adipisicin",
"Type": "a"
}
],
"TotalCharges": {
"CurrencyCode": "sit",
"MonetaryValue": "aute mol"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "dop",
"MonetaryValue": "aliquip in dol"
},
"TransportationCharges": {
"CurrencyCode": "ut ",
"MonetaryValue": "ullamco"
}
},
"ShipmentIdentificationNumber": "1ZW0ZPQBYHGYCSBCE8",
"SubProNumber": "occaecat in cillum officia",
"USI": "578299028T"
}
}
}{
"response": {
"errors": [
{
"code": "8",
"message": "Tracking number not found"
},
{
"code": "3",
"message": "Tracking number not found"
},
{
"code": "0",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "3",
"message": "Authentication failed"
},
{
"code": "0",
"message": "Tracking number not found"
},
{
"code": "7",
"message": "Invalid request parameter"
},
{
"code": "3",
"message": "System error"
},
{
"code": "6",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "3",
"message": "Authentication failed"
},
{
"code": "0",
"message": "System error"
},
{
"code": "0",
"message": "Tracking number not found"
},
{
"code": "4",
"message": "Tracking number not found"
},
{
"code": "5",
"message": "Invalid request parameter"
}
]
}
}DELETE
| Query Parameter Name | Example |
|---|---|
trackingnumber | commodo laboris Ut amet |
| Header Name | Example |
|---|---|
transId | "ad culpa" |
transactionSrc | "sint quis et aute dolore" |
{
"VoidShipmentResponse": {
"PackageLevelResults": [
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZD0IY5A4JPSNZSFRL"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZDT19FBFY0FGVSLXN"
},
{
"Status": {
"Code": "1",
"Description": "Not Voided"
},
"TrackingNumber": "1ZFE35UOQ69F437Z1X"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1Z19MGHT5NSE6NMEFW"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1Z28AU5W19C4F820IJ"
}
],
"Response": {
"Alert": {
"Code": "cill",
"Description": "occaecat pariatur dolore cupidatat"
},
"ResponseStatus": {
"Code": "u",
"Description": "in voluptate cillum"
},
"TransactionReference": {
"CustomerContext": "labore occaecat qui aliquip"
}
},
"SummaryResult": {
"Status": {
"Code": "1",
"Description": "Not Voided"
}
}
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "1",
"message": "Invalid request parameter"
},
{
"code": "5",
"message": "Authentication failed"
},
{
"code": "4",
"message": "Tracking number not found"
},
{
"code": "9",
"message": "Authentication failed"
},
{
"code": "0",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "3",
"message": "Invalid request parameter"
},
{
"code": "0",
"message": "Invalid request parameter"
},
{
"code": "9",
"message": "Invalid request parameter"
},
{
"code": "0",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "Invalid request parameter"
},
{
"code": "1",
"message": "Tracking number not found"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "deserunt" |
transactionSrc | "Duis non veniam reprehenderit" |
{
"LabelRecoveryRequest": {
"LabelDelivery": {
"LabelLinkIndicator": "",
"ResendEmailIndicator": ""
},
"LabelSpecification": {
"HTTPUserAgent": "Mozilla/4.5",
"LabelImageFormat": {
"Code": "ZPL"
},
"LabelStockSize": {
"Height": "6",
"Width": "4"
}
},
"Request": {
"RequestOption": "Non_Validate",
"SubVersion": "1903",
"TransactionReference": {
"CustomerContext": ""
}
},
"TrackingNumber": "1Z12345E8791315509",
"Translate": {
"Code": "01",
"DialectCode": "US",
"LanguageCode": "eng"
}
}
}Error generating example{
"response": {
"errors": [
{
"code": "9",
"message": "Authentication failed"
},
{
"code": "5",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "6",
"message": "System error"
},
{
"code": "7",
"message": "Tracking number not found"
},
{
"code": "0",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "Invalid request parameter"
},
{
"code": "9",
"message": "System error"
},
{
"code": "9",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "Authentication failed"
},
{
"code": "5",
"message": "System error"
}
]
}
}POST
| Query Parameter Name | Example |
|---|---|
additionaladdressvalidation | ad magna ut ullamco id |
| Header Name | Example |
|---|---|
transId | "fugiat consectetur Excepteur nostrud do" |
transactionSrc | "voluptate in" |
{
"ShipmentRequest": {
"Request": {
"SubVersion": "1801",
"RequestOption": "nonvalidate",
"TransactionReference": {
"CustomerContext": ""
}
},
"Shipment": {
"Description": "Ship WS test",
"Shipper": {
"Name": "ShipperName",
"AttentionName": "ShipperZs Attn Name",
"TaxIdentificationNumber": "123456",
"Phone": {
"Number": "1115554758",
"Extension": " "
},
"ShipperNumber": " ",
"FaxNumber": "8002222222",
"Address": {
"AddressLine": [
"2311 York Rd"
],
"City": "Timonium",
"StateProvinceCode": "MD",
"PostalCode": "21093",
"CountryCode": "US"
}
},
"ShipTo": {
"Name": "Happy Dog Pet Supply",
"AttentionName": "1160b_74",
"Phone": {
"Number": "9225377171"
},
"Address": {
"AddressLine": [
"123 Main St"
],
"City": "timonium",
"StateProvinceCode": "MD",
"PostalCode": "21030",
"CountryCode": "US"
},
"Residential": " "
},
"ShipFrom": {
"Name": "T and T Designs",
"AttentionName": "1160b_74",
"Phone": {
"Number": "1234567890"
},
"FaxNumber": "1234567890",
"Address": {
"AddressLine": [
"2311 York Rd"
],
"City": "Alpharetta",
"StateProvinceCode": "GA",
"PostalCode": "30005",
"CountryCode": "US"
}
},
"PaymentInformation": {
"ShipmentCharge": {
"Type": "01",
"BillShipper": {
"AccountNumber": " "
}
}
},
"Service": {
"Code": "03",
"Description": "Express"
},
"Package": {
"Description": " ",
"Packaging": {
"Code": "02",
"Description": "Nails"
},
"Dimensions": {
"UnitOfMeasurement": {
"Code": "IN",
"Description": "Inches"
},
"Length": "10",
"Width": "30",
"Height": "45"
},
"PackageWeight": {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "Pounds"
},
"Weight": "5"
}
}
},
"LabelSpecification": {
"LabelImageFormat": {
"Code": "GIF",
"Description": "GIF"
},
"HTTPUserAgent": "Mozilla/4.5"
}
}
}{
"ShipmentResponse": {
"Response": {
"Alert": [
{
"Code": "occae",
"Description": "labore commodo"
},
{
"Code": "et eu",
"Description": "consequat dolore non consectetur"
},
{
"Code": "consequat",
"Description": "minim ullamco velit aliqua"
},
{
"Code": "culp",
"Description": "officia et"
}
],
"ResponseStatus": {
"Code": "e",
"Description": "ea"
},
"TransactionReference": {
"CustomerContext": "consequat"
}
},
"ShipmentResults": {
"BarCodeImage": "nostrud sit",
"BillableWeightCalculationMethod": "et",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "eli",
"Description": "Duis reprehenderit"
},
"Weight": "in incid"
},
"BillOfLading": "culpa et eiusmod",
"CODTurnInPage": {
"Image": {
"GraphicImage": "nulla eiusmod exercitation",
"ImageFormat": {
"Code": "con",
"Description": "laboris tempor officia in"
}
}
},
"ControlLogReceipt": [
{
"GraphicImage": "ullamco ipsum dolore qui elit",
"ImageFormat": {
"Code": "ir",
"Description": "dolore"
}
},
{
"GraphicImage": "cillum fugiat",
"ImageFormat": {
"Code": "ess",
"Description": "fugiat"
}
},
{
"GraphicImage": "anim sed enim sunt",
"ImageFormat": {
"Code": "esse",
"Description": "fugiat anim eu"
}
},
{
"GraphicImage": "ullamco sed dolore consequat et",
"ImageFormat": {
"Code": "mi",
"Description": "cillum consectetur Excepteur"
}
}
],
"DGPaperImage": [
"reprehenderit laborum in",
"Duis anim pariatur incididunt",
"cupidatat",
"magna commodo Lorem"
],
"Disclaimer": [
{
"Code": "ex",
"Description": "Duis laborum Ut sit quis"
},
{
"Code": "co",
"Description": "proident"
},
{
"Code": "si",
"Description": "eiusmod"
}
],
"Form": {
"Code": "a",
"Description": "cillum sunt dolore vo",
"FormGroupId": "tempor en",
"FormGroupIdName": "rep",
"Image": {
"GraphicImage": "exercitation anim",
"ImageFormat": {
"Code": "nis",
"Description": "adipisic"
}
}
},
"FRSShipmentData": {
"FreightDensityRate": {
"Density": "des",
"TotalCubicFeet": "aliquip"
},
"HandlingUnits": [
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "la",
"Description": "aliqua Lorem pariatur ir"
},
"Value": "ut"
},
"Dimensions": {
"Height": "re",
"Length": "exer",
"UnitOfMeasurement": {
"Code": "ut",
"Description": "mollit laboris non id"
},
"Width": "sed mag"
},
"Quantity": "Except",
"Type": {
"Code": "in ",
"Description": "elit"
}
},
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "ad",
"Description": "voluptate laborum"
},
"Value": "Lorem ut"
},
"Dimensions": {
"Height": "qui fugiat",
"Length": "culpa es",
"UnitOfMeasurement": {
"Code": "do",
"Description": "nostrud nulla ve"
},
"Width": "laborum occaecat"
},
"Quantity": "sint Exc",
"Type": {
"Code": "iru",
"Description": "com"
}
}
],
"TransportationCharges": {
"DiscountAmount": {
"CurrencyCode": "ut ",
"MonetaryValue": "nostr"
},
"DiscountPercentage": "eu fu",
"GrossCharge": {
"CurrencyCode": "occ",
"MonetaryValue": "ut pariatu"
},
"NetCharge": {
"CurrencyCode": "iru",
"MonetaryValue": "eu aliqua"
}
}
},
"GCCN": "sint non ipsum dolor ut",
"HighValueReport": {
"Image": {
"GraphicImage": "velit Lorem ut",
"ImageFormat": {
"Code": "Exc",
"Description": "sint anim culpa sed"
}
}
},
"LabelURL": "incididunt ut",
"LocalLanguageLabelURL": "deserunt velit id",
"LocalLanguageReceiptURL": "qui esse exercitation commodo velit",
"MasterCartonID": "anim nostrud",
"Message": "Lorem pariatur occaecat",
"MIDualReturnShipmentKey": "id laboris labore sint proident",
"NegotiatedRateCharges": {
"ItemizedCharges": [
{
"Code": "id ",
"CurrencyCode": "lab",
"Description": "nostrud",
"MonetaryValue": "quis qui aliq",
"SubType": "esse ea commodo"
},
{
"Code": "des",
"CurrencyCode": "qui",
"Description": "in id esse qui nulla",
"MonetaryValue": "voluptate nulla dol",
"SubType": "aliquip sed magna inci"
},
{
"Code": "ut ",
"CurrencyCode": "cul",
"Description": "occaecat dolor adipisici",
"MonetaryValue": "dolor non",
"SubType": "adipisicing cillum elit"
},
{
"Code": "dol",
"CurrencyCode": "occ",
"Description": "moll",
"MonetaryValue": "qui minim ",
"SubType": "enim sit et ullamco"
},
{
"Code": "con",
"CurrencyCode": "ali",
"Description": "magna Excepteur ipsum",
"MonetaryValue": "aliqua no",
"SubType": "dolor adipisicing"
}
],
"RateModifier": [
{
"Amount": "ut Duis aliquipa",
"ModifierDesc": "in sitest elitseddo in consequat autesedculpa repr",
"ModifierType": "don"
},
{
"Amount": "nostrud nisi Uta",
"ModifierDesc": "dolor in adipisicing pariatur Loremelit velitenim ",
"ModifierType": "dol"
},
{
"Amount": "non irure est al",
"ModifierDesc": "cillum commodo magna doloradipisicingproident elit",
"ModifierType": "doc"
}
],
"TaxCharges": [
{
"MonetaryValue": "velit",
"Type": "reprehe"
},
{
"MonetaryValue": "comm",
"Type": "a"
},
{
"MonetaryValue": "velit qui u",
"Type": "exercita"
},
{
"MonetaryValue": "eu a",
"Type": "in"
},
{
"MonetaryValue": "occaecat",
"Type": "cupi"
}
],
"TotalCharge": {
"CurrencyCode": "in ",
"MonetaryValue": "voluptate enim"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "ani",
"MonetaryValue": "sint cillum"
}
},
"PackageResults": [
{
"Accessorial": [
{
"Code": "rep",
"Description": "voluptat"
},
{
"Code": "Lor",
"Description": "in"
}
],
"BaseServiceCharge": {
"CurrencyCode": "idq",
"MonetaryValue": "pariatur culp"
},
"CN22Number": "veniam pariatur proident nostrud quis",
"Form": {
"Code": "do",
"Description": "exercitation ut",
"FormGroupId": "occaecat",
"FormGroupIdName": "in Exc",
"Image": {
"GraphicImage": "aliquip laborum in laboris pariatur",
"ImageFormat": {
"Code": "qui",
"Description": "proi"
}
}
},
"ItemizedCharges": [
{
"Code": "in ",
"CurrencyCode": "eu ",
"Description": "sit veniam quis nostrud",
"MonetaryValue": "in quis",
"SubType": "occaecat esse ipsum"
},
{
"Code": "ull",
"CurrencyCode": "iru",
"Description": "fugiat",
"MonetaryValue": "ea Lorem null",
"SubType": "sed pariatur "
},
{
"Code": "in ",
"CurrencyCode": "ad ",
"Description": "officia aliqua ",
"MonetaryValue": "laboris",
"SubType": "laboris quis"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "ex ",
"CurrencyCode": "in ",
"Description": "min",
"MonetaryValue": "Excepteur lab",
"SubType": "do repreh"
},
{
"Code": "vel",
"CurrencyCode": "eu ",
"Description": "in amet nisi",
"MonetaryValue": "nulla culpa",
"SubType": "sunt labore nulla"
},
{
"Code": "non",
"CurrencyCode": "min",
"Description": "Excepteur aliqua do ipsum esse",
"MonetaryValue": "cil",
"SubType": "magna ut irure enim est"
}
],
"RateModifier": [
{
"Amount": "in incididunt ni",
"ModifierDesc": "laborum do incididunt tempor exanim laboris consec",
"ModifierType": "eli"
}
]
},
"RateModifier": [
{
"Amount": "au",
"ModifierDesc": "voluptate velit",
"ModifierType": "ips"
},
{
"Amount": "no",
"ModifierDesc": "eu occaecat in ad",
"ModifierType": "et "
},
{
"Amount": "a",
"ModifierDesc": "si",
"ModifierType": "in "
},
{
"Amount": "qui e",
"ModifierDesc": "aliquip in velit sunt eiusmod",
"ModifierType": "exe"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "iru",
"MonetaryValue": "do laborum al"
},
"ShippingLabel": {
"GraphicImage": "minim",
"GraphicImagePart": [
"consequat Duis proident",
"labore cupidatat",
"commodo",
"dolor commodo sit Excepteur est"
],
"HTMLImage": "est pariatur do",
"ImageFormat": {
"Code": "dol",
"Description": "Lor"
},
"InternationalSignatureGraphicImage": "do sit ut",
"PDF417": "aute aliquip elit id enim"
},
"ShippingReceipt": {
"GraphicImage": "laborum",
"ImageFormat": {
"Code": "si",
"Description": "proident mollit nulla do"
}
},
"SimpleRate": {
"Code": "ea"
},
"TrackingNumber": "incididunt id dolo",
"USPSPICNumber": "dolore Excepteur mollit dolore Lorem"
},
{
"Accessorial": [
{
"Code": "off",
"Description": "sint i"
}
],
"BaseServiceCharge": {
"CurrencyCode": "ips",
"MonetaryValue": "Ut c"
},
"CN22Number": "reprehenderit voluptate nulla adipisicing",
"Form": {
"Code": "co",
"Description": "in",
"FormGroupId": "amet",
"FormGroupIdName": "nulla irure officia",
"Image": {
"GraphicImage": "commodo aliqua",
"ImageFormat": {
"Code": "nul",
"Description": "dolor Excepteur aliqu"
}
}
},
"ItemizedCharges": [
{
"Code": "exe",
"CurrencyCode": "aut",
"Description": "dolor do",
"MonetaryValue": "ad",
"SubType": "et Ut proident ut"
},
{
"Code": "cul",
"CurrencyCode": "qui",
"Description": "anim dolore dolore",
"MonetaryValue": "d",
"SubType": "do Lorem ut"
},
{
"Code": "id ",
"CurrencyCode": "dol",
"Description": "incididunt nisi",
"MonetaryValue": "v",
"SubType": "reprehenderit magna in nisi"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "sin",
"CurrencyCode": "eiu",
"Description": "la",
"MonetaryValue": "ut ",
"SubType": "dolore ad"
},
{
"Code": "ada",
"CurrencyCode": "ame",
"Description": "laborum culpa in velit",
"MonetaryValue": "commodo volupta",
"SubType": "et offi"
},
{
"Code": "est",
"CurrencyCode": "Dui",
"Description": "aliquip labo",
"MonetaryValue": "id dolor ull",
"SubType": "sint occ"
},
{
"Code": "ess",
"CurrencyCode": "mag",
"Description": "commodo",
"MonetaryValue": "ea cillum",
"SubType": "irure ipsum"
}
],
"RateModifier": [
{
"Amount": "aute Ut exercita",
"ModifierDesc": "eiusmod exercitation culpa deserunt temporirure ei",
"ModifierType": "sin"
}
]
},
"RateModifier": [
{
"Amount": "incid",
"ModifierDesc": "veli",
"ModifierType": "ex "
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "nis",
"MonetaryValue": "irur"
},
"ShippingLabel": {
"GraphicImage": "dolore pariatur",
"GraphicImagePart": [
"tempor dolore",
"fugiat",
"amet anim non",
"nulla dolore labore voluptate"
],
"HTMLImage": "qui occaecat",
"ImageFormat": {
"Code": "in ",
"Description": "velit"
},
"InternationalSignatureGraphicImage": "non est eu",
"PDF417": "sunt enim sit"
},
"ShippingReceipt": {
"GraphicImage": "Ut aliquip nostrud eiusmod",
"ImageFormat": {
"Code": "aut",
"Description": "in nostrud adipisicing repreh"
}
},
"SimpleRate": {
"Code": "re"
},
"TrackingNumber": "ea deserunt nulla ",
"USPSPICNumber": "nostrud"
},
{
"Accessorial": [
{
"Code": "con",
"Description": "eiusmod sunt en"
},
{
"Code": "lab",
"Description": "ipsum adipisicing"
},
{
"Code": "nul",
"Description": "volu"
},
{
"Code": "ull",
"Description": "aute nul"
},
{
"Code": "mol",
"Description": "ullamco"
}
],
"BaseServiceCharge": {
"CurrencyCode": "cul",
"MonetaryValue": "dolore incididunt "
},
"CN22Number": "sit",
"Form": {
"Code": "ex",
"Description": "eu sint in",
"FormGroupId": "venia",
"FormGroupIdName": "mollit",
"Image": {
"GraphicImage": "deserunt ipsum",
"ImageFormat": {
"Code": "vel",
"Description": "laboris exe"
}
}
},
"ItemizedCharges": [
{
"Code": "nos",
"CurrencyCode": "ali",
"Description": "ut in ",
"MonetaryValue": "sunt sint",
"SubType": "incididun"
},
{
"Code": "min",
"CurrencyCode": "est",
"Description": "laborum do Excepteur mi",
"MonetaryValue": "nostrud veniam i",
"SubType": "d"
},
{
"Code": "dol",
"CurrencyCode": "par",
"Description": "veniam culpa non ullamco",
"MonetaryValue": "esse sun",
"SubType": "magna dolor"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "mol",
"CurrencyCode": "dol",
"Description": "ad a",
"MonetaryValue": "sit ",
"SubType": "eiusmod ea quis cillum"
},
{
"Code": "pro",
"CurrencyCode": "sun",
"Description": "i",
"MonetaryValue": "ullamco co",
"SubType": "Except"
},
{
"Code": "ex ",
"CurrencyCode": "con",
"Description": "amet sunt qui",
"MonetaryValue": "mol",
"SubType": "sed enim sint proident incididunt"
},
{
"Code": "ven",
"CurrencyCode": "cul",
"Description": "pariatur amet dol",
"MonetaryValue": "aliqui",
"SubType": "enim"
}
],
"RateModifier": [
{
"Amount": "enim do anim cil",
"ModifierDesc": "dolornulla consequat anim esseesseculpa elit ullam",
"ModifierType": "sun"
},
{
"Amount": "velitDuis enim c",
"ModifierDesc": "Ut Loremirure sed idtempor mollit quissedqui nisi ",
"ModifierType": "cil"
}
]
},
"RateModifier": [
{
"Amount": "dolor amet ani",
"ModifierDesc": "Lorem",
"ModifierType": "eni"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "aut",
"MonetaryValue": "fugiat labore"
},
"ShippingLabel": {
"GraphicImage": "ea labore",
"GraphicImagePart": [
"et quis officia",
"fugiat cupidatat laborum magna",
"laboris"
],
"HTMLImage": "deserunt ad labore",
"ImageFormat": {
"Code": "min",
"Description": "dolore sunt"
},
"InternationalSignatureGraphicImage": "amet quis cupidatat in consequat",
"PDF417": "dolore ullamco aliqua in exercitation"
},
"ShippingReceipt": {
"GraphicImage": "anim officia",
"ImageFormat": {
"Code": "c",
"Description": "sint dolore ex"
}
},
"SimpleRate": {
"Code": "ci"
},
"TrackingNumber": "eu nulla qui id do",
"USPSPICNumber": "non culpa laboris"
}
],
"PalletLabel": {
"PalletLabel": "cillum labore voluptate"
},
"RatingMethod": "mo",
"ReceiptURL": "consequat sit",
"RoarRatedIndicator": "pariatur",
"ShipmentCharges": {
"BaseServiceCharge": {
"CurrencyCode": "ide",
"MonetaryValue": "enim "
},
"ItemizedCharges": [
{
"Code": "sed",
"CurrencyCode": "adi",
"Description": "pariatur ut nostrud",
"MonetaryValue": "est enim qui occae",
"SubType": "aliqua"
}
],
"RateChart": "p",
"ServiceOptionsCharges": {
"CurrencyCode": "dol",
"MonetaryValue": "officia in se"
},
"TaxCharges": [
{
"MonetaryValue": "la",
"Type": "consequa"
}
],
"TotalCharges": {
"CurrencyCode": "sin",
"MonetaryValue": "consequat ex des"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "non",
"MonetaryValue": "a"
},
"TransportationCharges": {
"CurrencyCode": "ess",
"MonetaryValue": "id nostrud"
}
},
"ShipmentIdentificationNumber": "1ZQIJNLCW6OK3WG52D",
"SubProNumber": "labore in",
"USI": "578299028T"
}
}
}{
"response": {
"errors": [
{
"code": "9",
"message": "Authentication failed"
},
{
"code": "6",
"message": "Tracking number not found"
},
{
"code": "6",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "Tracking number not found"
},
{
"code": "9",
"message": "Authentication failed"
},
{
"code": "6",
"message": "Authentication failed"
},
{
"code": "8",
"message": "Invalid request parameter"
},
{
"code": "8",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "Authentication failed"
},
{
"code": "1",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "3",
"message": "Invalid request parameter"
}
]
}
}DELETE
| Query Parameter Name | Example |
|---|---|
trackingnumber | dolor elit voluptate anim tempor |
| Header Name | Example |
|---|---|
transId | "dolor" |
transactionSrc | "anim" |
{
"VoidShipmentResponse": {
"PackageLevelResults": [
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZPO1UB2GWT65LNBI8"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZAMDU73KPYX0RFZRT"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1Z99EYRCT2G6UB6I7S"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZBTBV8MH5OR6R931Y"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZWX79ML3606VK7CYN"
}
],
"Response": {
"Alert": {
"Code": "ad de",
"Description": "magna"
},
"ResponseStatus": {
"Code": "a",
"Description": "Excepteur sed off"
},
"TransactionReference": {
"CustomerContext": "minim"
}
},
"SummaryResult": {
"Status": {
"Code": "0",
"Description": "Already Voided"
}
}
}
}{
"response": {
"errors": [
{
"code": "9",
"message": "Tracking number not found"
},
{
"code": "7",
"message": "Tracking number not found"
},
{
"code": "8",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "3",
"message": "Authentication failed"
},
{
"code": "5",
"message": "Invalid request parameter"
},
{
"code": "6",
"message": "Invalid request parameter"
},
{
"code": "7",
"message": "Authentication failed"
},
{
"code": "9",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "0",
"message": "System error"
},
{
"code": "0",
"message": "Authentication failed"
},
{
"code": "9",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "2",
"message": "Authentication failed"
},
{
"code": "4",
"message": "Tracking number not found"
}
]
}
}Service Homepage: github.com/UPS-API/api-documentation/blob/main/Shipping.yaml
upsshippinglogisticsecommercerest