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 | do aute cupidatat |
| Header Name | Example |
|---|---|
transId | "do labore sit ut" |
transactionSrc | "tempor consequat amet" |
{
"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": "sit eiusmod magna sunt exercitation"
},
{
"Code": "in d",
"Description": "nulla exercitation irure occaecat"
}
],
"ResponseStatus": {
"Code": "r",
"Description": "id ex deserunt"
},
"TransactionReference": {
"CustomerContext": "quis dolor"
}
},
"ShipmentResults": {
"BarCodeImage": "occaecat amet dolor",
"BillableWeightCalculationMethod": "vo",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "Dui",
"Description": "ut"
},
"Weight": "ad tempo"
},
"BillOfLading": "nulla dolor",
"CODTurnInPage": {
"Image": {
"GraphicImage": "aute incididunt proident",
"ImageFormat": {
"Code": "Lor",
"Description": "Ut aute id "
}
}
},
"ControlLogReceipt": [
{
"GraphicImage": "exercitation",
"ImageFormat": {
"Code": "cu",
"Description": "commodo Duis quis ullamco"
}
},
{
"GraphicImage": "sit et cupidatat exercitation consequat",
"ImageFormat": {
"Code": "vo",
"Description": "mollit dolor"
}
},
{
"GraphicImage": "consectetur commodo nisi in",
"ImageFormat": {
"Code": "la",
"Description": "occaecat magna cupida"
}
},
{
"GraphicImage": "anim nisi aliquip pariatur",
"ImageFormat": {
"Code": "aliq",
"Description": "ut"
}
}
],
"DGPaperImage": [
"pariatur aliqua adipisicing exercitation sed",
"Excepteur deserunt culpa pariatur consequat",
"velit amet exercitation",
"deserunt dolore ad",
"sint Duis cillum"
],
"Disclaimer": [
{
"Code": "of",
"Description": "commodo"
},
{
"Code": "mi",
"Description": "cupidatat elit laboris nostrud"
}
],
"Form": {
"Code": "el",
"Description": "eu in la",
"FormGroupId": "qui ut",
"FormGroupIdName": "officia anim nostrud amet exerc",
"Image": {
"GraphicImage": "officia non dolore Excepteur",
"ImageFormat": {
"Code": "dol",
"Description": "velit in n"
}
}
},
"FRSShipmentData": {
"FreightDensityRate": {
"Density": "eius",
"TotalCubicFeet": "cillum"
},
"HandlingUnits": [
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "mi",
"Description": "enim"
},
"Value": "officia"
},
"Dimensions": {
"Height": "esse",
"Length": "ipsu",
"UnitOfMeasurement": {
"Code": "se",
"Description": "dolor "
},
"Width": "amet magna enim"
},
"Quantity": "in",
"Type": {
"Code": "mol",
"Description": "consequat pariatur cupidatat velit "
}
}
],
"TransportationCharges": {
"DiscountAmount": {
"CurrencyCode": "in ",
"MonetaryValue": "ut Lore"
},
"DiscountPercentage": "exer",
"GrossCharge": {
"CurrencyCode": "con",
"MonetaryValue": "magna in elit irure"
},
"NetCharge": {
"CurrencyCode": "mag",
"MonetaryValue": "et"
}
}
},
"GCCN": "et dolor officia nostrud irure",
"HighValueReport": {
"Image": {
"GraphicImage": "Lorem sed",
"ImageFormat": {
"Code": "ven",
"Description": "mollit minim ipsum"
}
}
},
"LabelURL": "ut aliquip",
"LocalLanguageLabelURL": "id",
"LocalLanguageReceiptURL": "incididunt ipsum proident nostrud minim",
"MasterCartonID": "fugiat anim",
"Message": "officia ipsum in tempor incididunt",
"MIDualReturnShipmentKey": "aute",
"NegotiatedRateCharges": {
"ItemizedCharges": [
{
"Code": "ame",
"CurrencyCode": "ind",
"Description": "amet qui ullamco sit",
"MonetaryValue": "dolore",
"SubType": "veniam do magna labore"
},
{
"Code": "con",
"CurrencyCode": "eli",
"Description": "voluptate",
"MonetaryValue": "aliqua voluptate",
"SubType": "consectetur Duis amet tempo"
},
{
"Code": "eiu",
"CurrencyCode": "nis",
"Description": "o",
"MonetaryValue": "ut ",
"SubType": "labore"
},
{
"Code": "inc",
"CurrencyCode": "ina",
"Description": "ex non cu",
"MonetaryValue": "incididunt do est",
"SubType": "mollit adipisicing velit"
}
],
"RateModifier": [
{
"Amount": "laborum qui Lore",
"ModifierDesc": "laboris labore velitin exercitation nisi sintminim",
"ModifierType": "id "
}
],
"TaxCharges": [
{
"MonetaryValue": "ven",
"Type": "nulla"
}
],
"TotalCharge": {
"CurrencyCode": "Exc",
"MonetaryValue": "ea nostru"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "mol",
"MonetaryValue": "enim ali"
}
},
"PackageResults": [
{
"Accessorial": [
{
"Code": "inc",
"Description": "dolor culpa aliqua ex proident"
}
],
"BaseServiceCharge": {
"CurrencyCode": "iru",
"MonetaryValue": "in sunt mo"
},
"CN22Number": "occaecat in in",
"Form": {
"Code": "in",
"Description": "non Lorem",
"FormGroupId": "elit mollit",
"FormGroupIdName": "occaecat",
"Image": {
"GraphicImage": "Duis nostrud",
"ImageFormat": {
"Code": "lab",
"Description": "ea"
}
}
},
"ItemizedCharges": [
{
"Code": "et ",
"CurrencyCode": "in ",
"Description": "aliquip i",
"MonetaryValue": "e",
"SubType": "sint culpa"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "ut ",
"CurrencyCode": "ut ",
"Description": "eu dolor cupidatat anim ad",
"MonetaryValue": "ut Excepteur ",
"SubType": "voluptate elit eu p"
},
{
"Code": "dol",
"CurrencyCode": "dol",
"Description": "o",
"MonetaryValue": "deserunt fu",
"SubType": "tempor voluptate id"
},
{
"Code": "cup",
"CurrencyCode": "ali",
"Description": "enim aliquip anim laboris",
"MonetaryValue": "a",
"SubType": "veniam ut in eiusmod"
},
{
"Code": "lab",
"CurrencyCode": "ut ",
"Description": "non incididunt consecte",
"MonetaryValue": "Excepteur ip",
"SubType": "ut"
}
],
"RateModifier": [
{
"Amount": "veniam mollitadl",
"ModifierDesc": "commodoUt adipisicingconsectetur autein qui in sun",
"ModifierType": "eiu"
},
{
"Amount": "consectetur aliq",
"ModifierDesc": "sunt ipsum dolorelit non dolor incididuntsed amet ",
"ModifierType": "ut "
},
{
"Amount": "nulla in dolor i",
"ModifierDesc": "sunt fugiat ea Duis ullamcoaliqua eiusmod elit nos",
"ModifierType": "adi"
},
{
"Amount": "eiusmod fugiat E",
"ModifierDesc": "enim cupidatat veniam exdolore inexercitation est ",
"ModifierType": "pro"
},
{
"Amount": "veniam doloreut ",
"ModifierDesc": "Duis dolore veniamminim occaecat ut Ut auteeiusmod",
"ModifierType": "ame"
}
]
},
"RateModifier": [
{
"Amount": "ea esse",
"ModifierDesc": "ex ",
"ModifierType": "ali"
},
{
"Amount": "eiusmo",
"ModifierDesc": "cupidatat eu",
"ModifierType": "do "
},
{
"Amount": "dolor dolore",
"ModifierDesc": "aute",
"ModifierType": "non"
},
{
"Amount": "est aliqu",
"ModifierDesc": "quis",
"ModifierType": "vol"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "id ",
"MonetaryValue": "in "
},
"ShippingLabel": {
"GraphicImage": "Duis amet",
"GraphicImagePart": [
"ex laborum"
],
"HTMLImage": "ex aliquip ut dolor laborum",
"ImageFormat": {
"Code": "sin",
"Description": "eu"
},
"InternationalSignatureGraphicImage": "dolor dolore in",
"PDF417": "eu laborum dolore deserunt"
},
"ShippingReceipt": {
"GraphicImage": "commodo laborum cupidatat mollit ullamco",
"ImageFormat": {
"Code": "temp",
"Description": "incididunt dolore vol"
}
},
"SimpleRate": {
"Code": "am"
},
"TrackingNumber": "in deserunt labori",
"USPSPICNumber": "nulla consequat dolore veniam anim"
},
{
"Accessorial": [
{
"Code": "eni",
"Description": "enim"
},
{
"Code": "vol",
"Description": "sunt officia incididunt"
},
{
"Code": "Ut ",
"Description": "nostrud laborum Lorem"
}
],
"BaseServiceCharge": {
"CurrencyCode": "ips",
"MonetaryValue": "Ut"
},
"CN22Number": "Lorem minim adipisicing cillum qui",
"Form": {
"Code": "se",
"Description": "labore des",
"FormGroupId": "laborum est aliqu",
"FormGroupIdName": "anim velit",
"Image": {
"GraphicImage": "ad labore proident cupidatat",
"ImageFormat": {
"Code": "in ",
"Description": "est labore Ut"
}
}
},
"ItemizedCharges": [
{
"Code": "adi",
"CurrencyCode": "dol",
"Description": "sunt cupidatat qui",
"MonetaryValue": "en",
"SubType": "do veniam"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "sit",
"CurrencyCode": "tem",
"Description": "occaecat irur",
"MonetaryValue": "enim proident ir",
"SubType": "tempor min"
},
{
"Code": "ull",
"CurrencyCode": "min",
"Description": "exercitation Ut i",
"MonetaryValue": "sit",
"SubType": "eiusmod tempor dolore lab"
}
],
"RateModifier": [
{
"Amount": "cillum magna ess",
"ModifierDesc": "culpa Excepteur in estculpa dolor proident ea mini",
"ModifierType": "exe"
},
{
"Amount": "irure ullamcocil",
"ModifierDesc": "officia nostrud consectetur laboris deseruntest la",
"ModifierType": "vel"
},
{
"Amount": "in sedeu enimsin",
"ModifierDesc": "ex incupidatat voluptate esseest dolore dolor temp",
"ModifierType": "dol"
},
{
"Amount": "Duis cillum cons",
"ModifierDesc": "dolore aliquipelit esseexercitationin cupidatat re",
"ModifierType": "des"
},
{
"Amount": "ut dolor sint am",
"ModifierDesc": "ullamco cupidatat officia quisminim laborismagna v",
"ModifierType": "Ut "
}
]
},
"RateModifier": [
{
"Amount": "i",
"ModifierDesc": "cupidatat et commodo culpa",
"ModifierType": "aut"
},
{
"Amount": "ame",
"ModifierDesc": "eiusmod",
"ModifierType": "dol"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "Lor",
"MonetaryValue": "amet nisi"
},
"ShippingLabel": {
"GraphicImage": "Duis Lorem",
"GraphicImagePart": [
"id",
"sed sunt deserunt ut nostrud",
"consequat nostrud minim",
"ut Excepteur mollit"
],
"HTMLImage": "anim sed aliqua officia culpa",
"ImageFormat": {
"Code": "exe",
"Description": "sunt ad"
},
"InternationalSignatureGraphicImage": "proident cupidatat nostrud Ut",
"PDF417": "cillum incididunt"
},
"ShippingReceipt": {
"GraphicImage": "consectetur",
"ImageFormat": {
"Code": "repr",
"Description": "adipisicing id aliquip"
}
},
"SimpleRate": {
"Code": "co"
},
"TrackingNumber": "ut mollitExcepteur",
"USPSPICNumber": "nulla"
}
],
"PalletLabel": {
"PalletLabel": "aute do veniam exercitation"
},
"RatingMethod": "re",
"ReceiptURL": "mollit",
"RoarRatedIndicator": "dolor pariatur in eiusmod",
"ShipmentCharges": {
"BaseServiceCharge": {
"CurrencyCode": "dol",
"MonetaryValue": "anim eiusmod eli"
},
"ItemizedCharges": [
{
"Code": "con",
"CurrencyCode": "cul",
"Description": "est reprehenderit consequat sunt",
"MonetaryValue": "nulla",
"SubType": "dolor occaecat pari"
},
{
"Code": "mol",
"CurrencyCode": "occ",
"Description": "elit nisi",
"MonetaryValue": "non vol",
"SubType": "do"
},
{
"Code": "ull",
"CurrencyCode": "eul",
"Description": "commodo",
"MonetaryValue": "ut eu ",
"SubType": "elit"
},
{
"Code": "in ",
"CurrencyCode": "ex ",
"Description": "deserunt",
"MonetaryValue": "Duis",
"SubType": "reprehenderit velit"
},
{
"Code": "uts",
"CurrencyCode": "ali",
"Description": "aliquip",
"MonetaryValue": "qui laboris nisi a",
"SubType": "Duis elit aute i"
}
],
"RateChart": "i",
"ServiceOptionsCharges": {
"CurrencyCode": "dol",
"MonetaryValue": "incididu"
},
"TaxCharges": [
{
"MonetaryValue": "Lorem",
"Type": "in aute "
}
],
"TotalCharges": {
"CurrencyCode": "in ",
"MonetaryValue": "est minim id eius"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "Exc",
"MonetaryValue": "ea enim"
},
"TransportationCharges": {
"CurrencyCode": "adi",
"MonetaryValue": "exercitati"
}
},
"ShipmentIdentificationNumber": "1Z1GZXM74F2IZCFVDB",
"SubProNumber": "qui",
"USI": "578299028T"
}
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "Tracking number not found"
},
{
"code": "9",
"message": "Authentication failed"
},
{
"code": "1",
"message": "Authentication failed"
},
{
"code": "0",
"message": "System error"
},
{
"code": "9",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "0",
"message": "System error"
},
{
"code": "6",
"message": "Tracking number not found"
},
{
"code": "9",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "8",
"message": "System error"
},
{
"code": "7",
"message": "Tracking number not found"
},
{
"code": "4",
"message": "Invalid request parameter"
},
{
"code": "8",
"message": "Authentication failed"
},
{
"code": "5",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "Authentication failed"
}
]
}
}DELETE
| Query Parameter Name | Example |
|---|---|
trackingnumber | incididunt laborum elit non ut |
| Header Name | Example |
|---|---|
transId | "tempor id" |
transactionSrc | "ex veniam sint" |
{
"VoidShipmentResponse": {
"PackageLevelResults": [
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZGE7UXQLLSRFHI0LE"
},
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZFICA8S6VB1WGEX22"
},
{
"Status": {
"Code": "1",
"Description": "Voided"
},
"TrackingNumber": "1ZZQFQFOMNS4Z99H5V"
}
],
"Response": {
"Alert": {
"Code": "sed",
"Description": "magna"
},
"ResponseStatus": {
"Code": "n",
"Description": "ut tempor"
},
"TransactionReference": {
"CustomerContext": "non ex eu officia"
}
},
"SummaryResult": {
"Status": {
"Code": "1",
"Description": "Voided"
}
}
}
}{
"response": {
"errors": [
{
"code": "8",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "8",
"message": "System error"
},
{
"code": "1",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "Authentication failed"
},
{
"code": "0",
"message": "Tracking number not found"
},
{
"code": "6",
"message": "Tracking number not found"
},
{
"code": "4",
"message": "Tracking number not found"
},
{
"code": "3",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "Invalid request parameter"
},
{
"code": "8",
"message": "Authentication failed"
},
{
"code": "5",
"message": "Authentication failed"
},
{
"code": "5",
"message": "Tracking number not found"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "ut dolor deserunt adipisicing" |
transactionSrc | "culpa consectetur ut ipsum incididunt" |
{
"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": "1",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "Tracking number not found"
},
{
"code": "8",
"message": "Tracking number not found"
},
{
"code": "6",
"message": "Invalid request parameter"
},
{
"code": "7",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "6",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "System error"
},
{
"code": "5",
"message": "Invalid request parameter"
}
]
}
}POST
| Query Parameter Name | Example |
|---|---|
additionaladdressvalidation | id Excepteur adipisicing |
| Header Name | Example |
|---|---|
transId | "laborum" |
transactionSrc | "Excepteur ex in aliquip" |
{
"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": "r",
"Description": "amet"
},
{
"Code": "sed pariat",
"Description": "in adipisicing cillum dolor sunt"
},
{
"Code": "voluptate",
"Description": "reprehenderit do"
}
],
"ResponseStatus": {
"Code": "i",
"Description": "laborum"
},
"TransactionReference": {
"CustomerContext": "ut mollit irure"
}
},
"ShipmentResults": {
"BarCodeImage": "Excepteur exercitation in Lorem irure",
"BillableWeightCalculationMethod": "al",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "con",
"Description": "pariatur est veniam sit"
},
"Weight": "nulla do"
},
"BillOfLading": "consectetur Lorem aliquip tempor est",
"CODTurnInPage": {
"Image": {
"GraphicImage": "nostrud",
"ImageFormat": {
"Code": "non",
"Description": "pariatur velit"
}
}
},
"ControlLogReceipt": [
{
"GraphicImage": "Ut cillum eu do amet",
"ImageFormat": {
"Code": "ut",
"Description": "dolor"
}
},
{
"GraphicImage": "quis ipsum fugiat esse reprehenderit",
"ImageFormat": {
"Code": "sit",
"Description": "dolor"
}
}
],
"DGPaperImage": [
"veniam est",
"quis enim labore eiusmod",
"cupidatat in"
],
"Disclaimer": [
{
"Code": "au",
"Description": "aliquip"
},
{
"Code": "se",
"Description": "aliqua"
}
],
"Form": {
"Code": "u",
"Description": "offici",
"FormGroupId": "magna ",
"FormGroupIdName": "veniam fugiat sit",
"Image": {
"GraphicImage": "dolore tempor veniam",
"ImageFormat": {
"Code": "ull",
"Description": "quis id incididun"
}
}
},
"FRSShipmentData": {
"FreightDensityRate": {
"Density": "pr",
"TotalCubicFeet": "in sit e"
},
"HandlingUnits": [
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "co",
"Description": "co"
},
"Value": "reprehenderit do"
},
"Dimensions": {
"Height": "amet volup",
"Length": "occaecat ",
"UnitOfMeasurement": {
"Code": "no",
"Description": "sed dolore"
},
"Width": "dolore mini"
},
"Quantity": "au",
"Type": {
"Code": "vol",
"Description": "minim"
}
}
],
"TransportationCharges": {
"DiscountAmount": {
"CurrencyCode": "ad ",
"MonetaryValue": "velit eiusm"
},
"DiscountPercentage": "lab",
"GrossCharge": {
"CurrencyCode": "utm",
"MonetaryValue": "cillum"
},
"NetCharge": {
"CurrencyCode": "ame",
"MonetaryValue": "ad labore aliqua in"
}
}
},
"GCCN": "eiusmod cillum culpa",
"HighValueReport": {
"Image": {
"GraphicImage": "quis eiusmod",
"ImageFormat": {
"Code": "pro",
"Description": "laboris de"
}
}
},
"LabelURL": "Duis dolor pariatur aliquip deserunt",
"LocalLanguageLabelURL": "eiusmod officia nulla",
"LocalLanguageReceiptURL": "officia aliquip anim Lorem cupidatat",
"MasterCartonID": "Lorem c",
"Message": "ea Excepteur",
"MIDualReturnShipmentKey": "dolor sint",
"NegotiatedRateCharges": {
"ItemizedCharges": [
{
"Code": "dol",
"CurrencyCode": "ali",
"Description": "cillum exercitation ut sint",
"MonetaryValue": "non",
"SubType": "dolor"
},
{
"Code": "in ",
"CurrencyCode": "lab",
"Description": "dolor sit esse culpa Lorem",
"MonetaryValue": "dolore",
"SubType": "dolore"
}
],
"RateModifier": [
{
"Amount": "ut laborum estco",
"ModifierDesc": "elit consectetur irure nostrudinut magna nostrud t",
"ModifierType": "Ut "
},
{
"Amount": "animea voluptate",
"ModifierDesc": "velit minim est pariatur adconsequat eu sint Excep",
"ModifierType": "iru"
},
{
"Amount": "id consequat ad ",
"ModifierDesc": "laboris cupidatat nostrud fugiat ullamcoquis sintp",
"ModifierType": "in "
},
{
"Amount": "voluptate Loremn",
"ModifierDesc": "aliquip veniam pariatur do minimpariatur nostrud i",
"ModifierType": "Ut "
},
{
"Amount": "sint dolor exerc",
"ModifierDesc": "iruretempor anim adipisicing in suntconsequatsint ",
"ModifierType": "ips"
}
],
"TaxCharges": [
{
"MonetaryValue": "labore eu do",
"Type": "ex aut"
},
{
"MonetaryValue": "laboris dol",
"Type": "in repreh"
},
{
"MonetaryValue": "ipsum cons",
"Type": "ad occ"
},
{
"MonetaryValue": "sit",
"Type": "iru"
},
{
"MonetaryValue": "cupidatat sunt sint",
"Type": "sunt"
}
],
"TotalCharge": {
"CurrencyCode": "dol",
"MonetaryValue": "reprehe"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "eum",
"MonetaryValue": "veniam et dol"
}
},
"PackageResults": [
{
"Accessorial": [
{
"Code": "lab",
"Description": "in velit nulla"
}
],
"BaseServiceCharge": {
"CurrencyCode": "sun",
"MonetaryValue": "ipsum sint sit an"
},
"CN22Number": "in do veniam",
"Form": {
"Code": "cu",
"Description": "velit commodo v",
"FormGroupId": "pa",
"FormGroupIdName": "occaecat",
"Image": {
"GraphicImage": "aute exercitation eu",
"ImageFormat": {
"Code": "vel",
"Description": "esse nisi labore E"
}
}
},
"ItemizedCharges": [
{
"Code": "ame",
"CurrencyCode": "sit",
"Description": "dolor i",
"MonetaryValue": "eli",
"SubType": "amet nostrud ad veniam"
},
{
"Code": "ull",
"CurrencyCode": "ull",
"Description": "laboris occ",
"MonetaryValue": "ut",
"SubType": "exercitation no"
},
{
"Code": "sin",
"CurrencyCode": "ut ",
"Description": "laboris in mo",
"MonetaryValue": "velit",
"SubType": "eu enim"
},
{
"Code": "eiu",
"CurrencyCode": "vel",
"Description": "occa",
"MonetaryValue": "non nostrud ",
"SubType": "ut sint"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "tem",
"CurrencyCode": "mag",
"Description": "ad",
"MonetaryValue": "ea dolor ",
"SubType": "sit fu"
},
{
"Code": "ame",
"CurrencyCode": "est",
"Description": "dolor nulla labore quis in",
"MonetaryValue": "esse ",
"SubType": "sed sint aliquip ut"
}
],
"RateModifier": [
{
"Amount": "labore ea et Dui",
"ModifierDesc": "laborumquis magna occaecat velitincididuntdeserunt",
"ModifierType": "in "
},
{
"Amount": "Duis consequat i",
"ModifierDesc": "est occaecat Ut pariaturadeu in enim Lorem doloree",
"ModifierType": "rep"
},
{
"Amount": "mollit ut culpac",
"ModifierDesc": "non aute exDuis utculpa irureeiusmodconsequat inla",
"ModifierType": "eu "
}
]
},
"RateModifier": [
{
"Amount": "sit in",
"ModifierDesc": "eu",
"ModifierType": "pro"
},
{
"Amount": "cil",
"ModifierDesc": "nisi dolor ullamco in m",
"ModifierType": "par"
},
{
"Amount": "Ex",
"ModifierDesc": "labore",
"ModifierType": "dol"
},
{
"Amount": "sit id",
"ModifierDesc": "velit eu enim nulla",
"ModifierType": "lab"
},
{
"Amount": "incidid",
"ModifierDesc": "pariatu",
"ModifierType": "qui"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "cul",
"MonetaryValue": "conseq"
},
"ShippingLabel": {
"GraphicImage": "consectetur adipisicing ullamco reprehenderit",
"GraphicImagePart": [
"incididunt"
],
"HTMLImage": "culpa adipisicing ut",
"ImageFormat": {
"Code": "iru",
"Description": "proident Lorem"
},
"InternationalSignatureGraphicImage": "commodo ad cillum eu culpa",
"PDF417": "cillum exercitation"
},
"ShippingReceipt": {
"GraphicImage": "cillum",
"ImageFormat": {
"Code": "m",
"Description": "nulla ex Duis magna minim"
}
},
"SimpleRate": {
"Code": "in"
},
"TrackingNumber": "dolore do deserunt",
"USPSPICNumber": "velit Duis dolor non"
},
{
"Accessorial": [
{
"Code": "non",
"Description": "incididun"
},
{
"Code": "com",
"Description": "incididunt labore"
},
{
"Code": "dol",
"Description": "veniam nisi non"
}
],
"BaseServiceCharge": {
"CurrencyCode": "ea ",
"MonetaryValue": "Exc"
},
"CN22Number": "dolore laboris",
"Form": {
"Code": "no",
"Description": "mollit quis qui ea",
"FormGroupId": "ea do",
"FormGroupIdName": "quis aute sed",
"Image": {
"GraphicImage": "dolor",
"ImageFormat": {
"Code": "des",
"Description": "elit sed labore"
}
}
},
"ItemizedCharges": [
{
"Code": "eni",
"CurrencyCode": "min",
"Description": "adipisicing",
"MonetaryValue": "tem",
"SubType": "Duis"
},
{
"Code": "des",
"CurrencyCode": "par",
"Description": "ipsum",
"MonetaryValue": "aliqua nostrud",
"SubType": "in"
},
{
"Code": "lab",
"CurrencyCode": "ut ",
"Description": "Duis culpa",
"MonetaryValue": "eu id dolor volup",
"SubType": "mollit Lorem"
},
{
"Code": "nul",
"CurrencyCode": "eaU",
"Description": "culpa ex ad sint",
"MonetaryValue": "mollit culp",
"SubType": "incididunt Ut voluptate"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "cup",
"CurrencyCode": "eiu",
"Description": "volupt",
"MonetaryValue": "nostrud inci",
"SubType": "sunt sint Duis Ut"
},
{
"Code": "occ",
"CurrencyCode": "sit",
"Description": "quis nisi",
"MonetaryValue": "occaecat Ut s",
"SubType": "Excepteur adipisicing"
},
{
"Code": "eli",
"CurrencyCode": "pro",
"Description": "mollit ipsum consecte",
"MonetaryValue": "ad a",
"SubType": "magna cupidat"
},
{
"Code": "nul",
"CurrencyCode": "utl",
"Description": "ea non dolore",
"MonetaryValue": "ut ullamco qui",
"SubType": "laboris occaecat ut labore elit"
},
{
"Code": "Lor",
"CurrencyCode": "occ",
"Description": "dolor",
"MonetaryValue": "n",
"SubType": "deserunt"
}
],
"RateModifier": [
{
"Amount": "cupidatat tempor",
"ModifierDesc": "voluptate officia cupidatatconsequat amettempor cu",
"ModifierType": "iru"
}
]
},
"RateModifier": [
{
"Amount": "consequa",
"ModifierDesc": "dolore eiusmod anim exercit",
"ModifierType": "off"
},
{
"Amount": "est irure",
"ModifierDesc": "enim dolore in minim",
"ModifierType": "lab"
},
{
"Amount": "Lorem n",
"ModifierDesc": "magna eiusmod quis esse ad",
"ModifierType": "dol"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "eue",
"MonetaryValue": "cupidatat eiusm"
},
"ShippingLabel": {
"GraphicImage": "labore aliqua amet sed",
"GraphicImagePart": [
"Ut sint",
"sit irure ad cupidatat pariatur",
"dolore sint tempor",
"anim eu elit cupidatat",
"aliqua est ut"
],
"HTMLImage": "dolore",
"ImageFormat": {
"Code": "ex ",
"Description": "anim sit consectetur quis"
},
"InternationalSignatureGraphicImage": "veniam Duis culpa",
"PDF417": "voluptate ex"
},
"ShippingReceipt": {
"GraphicImage": "in officia",
"ImageFormat": {
"Code": "pro",
"Description": "ea"
}
},
"SimpleRate": {
"Code": "co"
},
"TrackingNumber": "nulla ea ex est ul",
"USPSPICNumber": "non eu pariatur eiusmod"
}
],
"PalletLabel": {
"PalletLabel": "sed"
},
"RatingMethod": "la",
"ReceiptURL": "nostrud esse in",
"RoarRatedIndicator": "et",
"ShipmentCharges": {
"BaseServiceCharge": {
"CurrencyCode": "cup",
"MonetaryValue": "fugiat v"
},
"ItemizedCharges": [
{
"Code": "min",
"CurrencyCode": "con",
"Description": "deserunt ad occaecat laboris",
"MonetaryValue": "offic",
"SubType": "proident ut sint"
},
{
"Code": "Dui",
"CurrencyCode": "eu ",
"Description": "cupidata",
"MonetaryValue": "et ex amet es",
"SubType": "ad veniam ut"
},
{
"Code": "qui",
"CurrencyCode": "ex ",
"Description": "in ",
"MonetaryValue": "quis esse",
"SubType": "do lab"
},
{
"Code": "des",
"CurrencyCode": "lab",
"Description": "quis in Ut et ullamco",
"MonetaryValue": "sed labore dolor",
"SubType": "in reprehenderit sunt"
},
{
"Code": "vol",
"CurrencyCode": "lab",
"Description": "aute Ut anim aliquip dolore",
"MonetaryValue": "repre",
"SubType": "commodo qui aliqua officia"
}
],
"RateChart": "a",
"ServiceOptionsCharges": {
"CurrencyCode": "eli",
"MonetaryValue": "nis"
},
"TaxCharges": [
{
"MonetaryValue": "culpa amet ",
"Type": "labo"
}
],
"TotalCharges": {
"CurrencyCode": "in ",
"MonetaryValue": "deserunt"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "ani",
"MonetaryValue": "nostru"
},
"TransportationCharges": {
"CurrencyCode": "in ",
"MonetaryValue": "sunt"
}
},
"ShipmentIdentificationNumber": "1ZF2KSAH3GTJH2SIH2",
"SubProNumber": "culpa",
"USI": "578299028T"
}
}
}{
"response": {
"errors": [
{
"code": "9",
"message": "System error"
},
{
"code": "3",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "1",
"message": "Tracking number not found"
},
{
"code": "2",
"message": "System error"
},
{
"code": "9",
"message": "Invalid request parameter"
},
{
"code": "7",
"message": "Invalid request parameter"
},
{
"code": "3",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "1",
"message": "Authentication failed"
},
{
"code": "1",
"message": "Tracking number not found"
},
{
"code": "4",
"message": "Invalid request parameter"
},
{
"code": "8",
"message": "Authentication failed"
},
{
"code": "3",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "2",
"message": "Authentication failed"
},
{
"code": "6",
"message": "Authentication failed"
},
{
"code": "7",
"message": "Authentication failed"
},
{
"code": "6",
"message": "Invalid request parameter"
},
{
"code": "9",
"message": "Invalid request parameter"
}
]
}
}DELETE
| Query Parameter Name | Example |
|---|---|
trackingnumber | enim laboris |
| Header Name | Example |
|---|---|
transId | "tempor deserunt minim" |
transactionSrc | "elit dolor fugiat do" |
{
"VoidShipmentResponse": {
"PackageLevelResults": [
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZUCIOA9VQ9VIWX3HG"
},
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZNI9RHUD5YKS6MYL5"
},
{
"Status": {
"Code": "0",
"Description": "Voided"
},
"TrackingNumber": "1ZU753X6QKA5MR11LP"
},
{
"Status": {
"Code": "1",
"Description": "Not Voided"
},
"TrackingNumber": "1ZXAMTRAOQ3YM8VK2C"
},
{
"Status": {
"Code": "1",
"Description": "Voided"
},
"TrackingNumber": "1Z4KID55S5CQPFAQ8S"
}
],
"Response": {
"Alert": {
"Code": "velit ve",
"Description": "occaecat ad "
},
"ResponseStatus": {
"Code": "v",
"Description": "c"
},
"TransactionReference": {
"CustomerContext": "dolore sunt"
}
},
"SummaryResult": {
"Status": {
"Code": "1",
"Description": "Already Voided"
}
}
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "System error"
},
{
"code": "7",
"message": "Tracking number not found"
},
{
"code": "5",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "8",
"message": "Invalid request parameter"
},
{
"code": "2",
"message": "Invalid request parameter"
},
{
"code": "0",
"message": "Authentication failed"
},
{
"code": "3",
"message": "System error"
}
]
}
}Service Homepage: github.com/UPS-API/api-documentation/blob/main/Shipping.yaml
upsshippinglogisticsecommercerest