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 | eiusmod dolore sunt |
| Header Name | Example |
|---|---|
transId | "dolore elit cillum" |
transactionSrc | "ad" |
{
"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": "ven",
"Description": "labore"
},
{
"Code": "mo",
"Description": "occaecat sunt"
},
{
"Code": "irure ",
"Description": "dolor dolore ullamco labore"
}
],
"ResponseStatus": {
"Code": "s",
"Description": "qui aute"
},
"TransactionReference": {
"CustomerContext": "et tempor qui"
}
},
"ShipmentResults": {
"BarCodeImage": "Lorem nulla sed exercitation laboris",
"BillableWeightCalculationMethod": "la",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "ea ",
"Description": "sint sed nisi"
},
"Weight": "cupidata"
},
"BillOfLading": "incididunt",
"CODTurnInPage": {
"Image": {
"GraphicImage": "culpa Duis voluptate esse quis",
"ImageFormat": {
"Code": "dol",
"Description": "aliq"
}
}
},
"ControlLogReceipt": [
{
"GraphicImage": "culpa mollit Duis adipisicing fugiat",
"ImageFormat": {
"Code": "el",
"Description": "dolore"
}
},
{
"GraphicImage": "aliqua",
"ImageFormat": {
"Code": "volu",
"Description": "t"
}
},
{
"GraphicImage": "laborum culpa tempor incididunt",
"ImageFormat": {
"Code": "in",
"Description": "laborum"
}
},
{
"GraphicImage": "laboris reprehenderit ad dolor ex",
"ImageFormat": {
"Code": "amet",
"Description": "sed Lorem con"
}
}
],
"DGPaperImage": [
"irure voluptate cupidatat qui fugiat",
"non reprehenderit",
"labore",
"aliquip laborum nostrud quis"
],
"Disclaimer": [
{
"Code": "ex",
"Description": "do tempor Duis labore"
},
{
"Code": "vo",
"Description": "Lorem quis"
},
{
"Code": "ad",
"Description": "in sit Duis esse"
}
],
"Form": {
"Code": "et",
"Description": "consequat",
"FormGroupId": "ut eu lab",
"FormGroupIdName": "et",
"Image": {
"GraphicImage": "sit",
"ImageFormat": {
"Code": "lab",
"Description": "laborum aliqua ex sunt dolor"
}
}
},
"FRSShipmentData": {
"FreightDensityRate": {
"Density": "a",
"TotalCubicFeet": "Excepteur"
},
"HandlingUnits": [
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "su",
"Description": "enim adipisicin"
},
"Value": "ut d"
},
"Dimensions": {
"Height": "aliquip",
"Length": "aute Ut proiden",
"UnitOfMeasurement": {
"Code": "se",
"Description": "id sed nostrud"
},
"Width": "nulla ipsum ame"
},
"Quantity": "pariat",
"Type": {
"Code": "lab",
"Description": "mollit aliqu"
}
},
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "qu",
"Description": "consectetur amet voluptate dol"
},
"Value": "exercitation irure"
},
"Dimensions": {
"Height": "dolor ea ",
"Length": "in laboris mag",
"UnitOfMeasurement": {
"Code": "no",
"Description": "ut"
},
"Width": "esse pr"
},
"Quantity": "labo",
"Type": {
"Code": "dol",
"Description": "sed ipsum reprehend"
}
},
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "fu",
"Description": "velit commod"
},
"Value": "consequat iru"
},
"Dimensions": {
"Height": "a",
"Length": "dolore",
"UnitOfMeasurement": {
"Code": "la",
"Description": "nisi esse veli"
},
"Width": "Ut"
},
"Quantity": "su",
"Type": {
"Code": "ani",
"Description": "voluptate ex dolor cupida"
}
}
],
"TransportationCharges": {
"DiscountAmount": {
"CurrencyCode": "Dui",
"MonetaryValue": "id"
},
"DiscountPercentage": "nisi ",
"GrossCharge": {
"CurrencyCode": "et ",
"MonetaryValue": "proident veni"
},
"NetCharge": {
"CurrencyCode": "exe",
"MonetaryValue": "sint dolor"
}
}
},
"GCCN": "sunt",
"HighValueReport": {
"Image": {
"GraphicImage": "et anim velit",
"ImageFormat": {
"Code": "con",
"Description": "co"
}
}
},
"LabelURL": "ut cupidatat magna commodo",
"LocalLanguageLabelURL": "esse aliqua tempor qui dolor",
"LocalLanguageReceiptURL": "mollit",
"MasterCartonID": "est sunt",
"Message": "enim",
"MIDualReturnShipmentKey": "dolore",
"NegotiatedRateCharges": {
"ItemizedCharges": [
{
"Code": "fug",
"CurrencyCode": "ali",
"Description": "adipisicing veniam cupidatat",
"MonetaryValue": "sunt lab",
"SubType": "irure"
}
],
"RateModifier": [
{
"Amount": "non sed occaecat",
"ModifierDesc": "magna Excepteurculpaeiusmod aliquaipsumsunt eu do ",
"ModifierType": "sin"
},
{
"Amount": "officiain dolore",
"ModifierDesc": "in labore proident officiadolor labore Duis quisea",
"ModifierType": "iru"
},
{
"Amount": "tempor quiirure ",
"ModifierDesc": "sunt amet quisUt dolor occaecat sitUtdo dolore non",
"ModifierType": "cul"
}
],
"TaxCharges": [
{
"MonetaryValue": "culpa",
"Type": "la"
}
],
"TotalCharge": {
"CurrencyCode": "rep",
"MonetaryValue": "in"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "fug",
"MonetaryValue": "id dolore"
}
},
"PackageResults": [
{
"Accessorial": [
{
"Code": "con",
"Description": "velit aliquip "
},
{
"Code": "ex ",
"Description": "veniam ullamco"
},
{
"Code": "sin",
"Description": "i"
},
{
"Code": "mag",
"Description": "non in voluptate aute"
}
],
"BaseServiceCharge": {
"CurrencyCode": "vel",
"MonetaryValue": "sed"
},
"CN22Number": "officia",
"Form": {
"Code": "am",
"Description": "eius",
"FormGroupId": "Excepteur",
"FormGroupIdName": "magna",
"Image": {
"GraphicImage": "in",
"ImageFormat": {
"Code": "ess",
"Description": "do enim"
}
}
},
"ItemizedCharges": [
{
"Code": "ine",
"CurrencyCode": "ani",
"Description": "ven",
"MonetaryValue": "dese",
"SubType": "in d"
},
{
"Code": "ad ",
"CurrencyCode": "con",
"Description": "velit repreh",
"MonetaryValue": "irure minim reprehe",
"SubType": "ex ip"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "rep",
"CurrencyCode": "ips",
"Description": "proident aute",
"MonetaryValue": "enim",
"SubType": "Ut "
},
{
"Code": "cul",
"CurrencyCode": "Lor",
"Description": "quis sit consectetur qui",
"MonetaryValue": "qui",
"SubType": "ad Ut enim n"
}
],
"RateModifier": [
{
"Amount": "aliquipmagnasunt",
"ModifierDesc": "consectetur qui reprehenderitExcepteur in consequa",
"ModifierType": "con"
},
{
"Amount": "officiaeiusmodla",
"ModifierDesc": "do pariaturin consequat essedeserunt non Duis amet",
"ModifierType": "nos"
}
]
},
"RateModifier": [
{
"Amount": "cul",
"ModifierDesc": "al",
"ModifierType": "occ"
},
{
"Amount": "E",
"ModifierDesc": "irure",
"ModifierType": "ut "
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "mag",
"MonetaryValue": "labore rep"
},
"ShippingLabel": {
"GraphicImage": "qui sed",
"GraphicImagePart": [
"Excepteur officia"
],
"HTMLImage": "consequat",
"ImageFormat": {
"Code": "tem",
"Description": "in laborum"
},
"InternationalSignatureGraphicImage": "officia non",
"PDF417": "labore Lorem"
},
"ShippingReceipt": {
"GraphicImage": "Duis",
"ImageFormat": {
"Code": "in",
"Description": "magna mo"
}
},
"SimpleRate": {
"Code": "si"
},
"TrackingNumber": "cupidatat veniam d",
"USPSPICNumber": "sunt laboris fugiat culpa tempor"
},
{
"Accessorial": [
{
"Code": "sit",
"Description": "Ut dolore commodo nostrud sit"
},
{
"Code": "rep",
"Description": "incididun"
},
{
"Code": "non",
"Description": "dolor laboris consequat fugiat esse"
},
{
"Code": "ess",
"Description": "occae"
},
{
"Code": "ut ",
"Description": "in ex commodo deserunt"
}
],
"BaseServiceCharge": {
"CurrencyCode": "vel",
"MonetaryValue": "laboris id"
},
"CN22Number": "dolor tempor magna",
"Form": {
"Code": "ip",
"Description": "tempor ut nis",
"FormGroupId": "labore voluptate iru",
"FormGroupIdName": "proident id aliquip sint",
"Image": {
"GraphicImage": "sed minim adipisicing laborum",
"ImageFormat": {
"Code": "Dui",
"Description": "incididunt pariatur veniam"
}
}
},
"ItemizedCharges": [
{
"Code": "pro",
"CurrencyCode": "ani",
"Description": "adipisicing commodo e",
"MonetaryValue": "ullamco",
"SubType": "dolore volupta"
},
{
"Code": "est",
"CurrencyCode": "dol",
"Description": "sed",
"MonetaryValue": "ullamco ",
"SubType": "occaecat fugiat minim Duis"
},
{
"Code": "ex ",
"CurrencyCode": "con",
"Description": "velit ex",
"MonetaryValue": "irure",
"SubType": "non"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "ess",
"CurrencyCode": "off",
"Description": "tempor ",
"MonetaryValue": "adipisicing dolore ",
"SubType": "ut occaecat"
},
{
"Code": "Exc",
"CurrencyCode": "par",
"Description": "pariat",
"MonetaryValue": "dolore deser",
"SubType": "dolore"
},
{
"Code": "rep",
"CurrencyCode": "cul",
"Description": "sint aliquip cillum qui",
"MonetaryValue": "quis",
"SubType": "nostrud et veniam culpa"
},
{
"Code": "lab",
"CurrencyCode": "est",
"Description": "consequat in nostrud dolor do",
"MonetaryValue": "anim es",
"SubType": "id incididunt veniam"
}
],
"RateModifier": [
{
"Amount": "in incididunt es",
"ModifierDesc": "dolor enimsit ut quis in doloreullamco dolor tempo",
"ModifierType": "sit"
},
{
"Amount": "ex in enimmollit",
"ModifierDesc": "laborisminim ad aliquipreprehenderitex Duisadenim ",
"ModifierType": "fug"
},
{
"Amount": "dolor nonproiden",
"ModifierDesc": "ex reprehenderit officia deseruntsit amet exercita",
"ModifierType": "Exc"
},
{
"Amount": "cupidatat minim ",
"ModifierDesc": "qui tempor officia quis adpariaturin cillum eiusmo",
"ModifierType": "ut "
}
]
},
"RateModifier": [
{
"Amount": "ex culpa in",
"ModifierDesc": "ullamco velit culpa id",
"ModifierType": "dol"
},
{
"Amount": "cillum",
"ModifierDesc": "reprehenderit ex",
"ModifierType": "ips"
},
{
"Amount": "in",
"ModifierDesc": "consequat cillum tempor ut",
"ModifierType": "et "
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "nul",
"MonetaryValue": "commodo enim"
},
"ShippingLabel": {
"GraphicImage": "Ut Lorem exercitation",
"GraphicImagePart": [
"ad minim voluptate sunt consequat",
"dolor in quis sit reprehenderit"
],
"HTMLImage": "cupidatat ea in labore",
"ImageFormat": {
"Code": "doe",
"Description": "est eni"
},
"InternationalSignatureGraphicImage": "incididunt consequat Duis occaecat reprehenderit",
"PDF417": "commodo"
},
"ShippingReceipt": {
"GraphicImage": "laboris qui deserunt",
"ImageFormat": {
"Code": "do",
"Description": "do elit"
}
},
"SimpleRate": {
"Code": "ma"
},
"TrackingNumber": "anim Ut ea occaeca",
"USPSPICNumber": "sunt incididunt non ex"
},
{
"Accessorial": [
{
"Code": "cil",
"Description": "deserunt"
},
{
"Code": "et ",
"Description": "ven"
},
{
"Code": "ea ",
"Description": "consequat anim Excepteur Ut en"
},
{
"Code": "ame",
"Description": "tempor"
}
],
"BaseServiceCharge": {
"CurrencyCode": "exc",
"MonetaryValue": "commodo quis q"
},
"CN22Number": "reprehenderit",
"Form": {
"Code": "co",
"Description": "fugiat pariatur",
"FormGroupId": "id Excepteu",
"FormGroupIdName": "amet consequat deserunt ut",
"Image": {
"GraphicImage": "et nulla consequat",
"ImageFormat": {
"Code": "aut",
"Description": "veniam aute"
}
}
},
"ItemizedCharges": [
{
"Code": "inc",
"CurrencyCode": "ess",
"Description": "nostrud pariatur officia dolor ",
"MonetaryValue": "irure consequat ",
"SubType": "velit Excepteur amet consequat"
},
{
"Code": "id ",
"CurrencyCode": "sed",
"Description": "officia labore",
"MonetaryValue": "laboris exercitat",
"SubType": "incididunt"
},
{
"Code": "occ",
"CurrencyCode": "con",
"Description": "dolor sunt Lorem labor",
"MonetaryValue": "velit",
"SubType": "adipisicing nulla velit id fugiat"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "in ",
"CurrencyCode": "do ",
"Description": "sint",
"MonetaryValue": "ea ",
"SubType": "fugiat deserunt ea sint aliqua"
},
{
"Code": "aut",
"CurrencyCode": "sit",
"Description": "nostrud ipsum et mollit occaecat",
"MonetaryValue": "sit",
"SubType": "elit Duis sunt"
},
{
"Code": "off",
"CurrencyCode": "iru",
"Description": "es",
"MonetaryValue": "irure Lo",
"SubType": "dolor sit ut"
}
],
"RateModifier": [
{
"Amount": "amet reprehender",
"ModifierDesc": "labore sunt fugiat culpa incididuntenimipsum elit ",
"ModifierType": "sed"
},
{
"Amount": "cillum tempor do",
"ModifierDesc": "inet nulla iruremollit eu consectetur estquisenim ",
"ModifierType": "cil"
},
{
"Amount": "nostrudofficia a",
"ModifierDesc": "ad elitelit consectetur nisi pariatur inoccaecat D",
"ModifierType": "mag"
},
{
"Amount": "do id ullamco cu",
"ModifierDesc": "eiusmod sunt minim veniamLorem inin dolorepariatur",
"ModifierType": "con"
},
{
"Amount": "non aliqua dolor",
"ModifierDesc": "dolor aliquip magna occaecateu auteDuis irure offi",
"ModifierType": "adi"
}
]
},
"RateModifier": [
{
"Amount": "aute ",
"ModifierDesc": "Ut sit",
"ModifierType": "con"
},
{
"Amount": "ipsum Du",
"ModifierDesc": "est mollit ea et laborum",
"ModifierType": "off"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "dol",
"MonetaryValue": "commodo laboris"
},
"ShippingLabel": {
"GraphicImage": "cillum amet",
"GraphicImagePart": [
"sit nisi",
"est",
"proident eiusmod aute",
"ea ipsum nostrud ad et",
"ullamco aute id consequat in"
],
"HTMLImage": "Lorem",
"ImageFormat": {
"Code": "dol",
"Description": "amet Duis fugi"
},
"InternationalSignatureGraphicImage": "nostrud irure veniam",
"PDF417": "ad mollit sit Ut quis"
},
"ShippingReceipt": {
"GraphicImage": "ut sit velit",
"ImageFormat": {
"Code": "sin",
"Description": "esse sunt"
}
},
"SimpleRate": {
"Code": "cu"
},
"TrackingNumber": "sunt amet velit eu",
"USPSPICNumber": "ad exercitation"
},
{
"Accessorial": [
{
"Code": "sit",
"Description": "ea nisi in"
}
],
"BaseServiceCharge": {
"CurrencyCode": "ani",
"MonetaryValue": "commodo velit"
},
"CN22Number": "ut",
"Form": {
"Code": "ci",
"Description": "fugiat",
"FormGroupId": "ad ",
"FormGroupIdName": "cons",
"Image": {
"GraphicImage": "dolor consectetur",
"ImageFormat": {
"Code": "min",
"Description": "amet tempor ali"
}
}
},
"ItemizedCharges": [
{
"Code": "sin",
"CurrencyCode": "ess",
"Description": "nostrud",
"MonetaryValue": "aute Duis ",
"SubType": "aliquip sunt proident"
},
{
"Code": "sin",
"CurrencyCode": "sin",
"Description": "aute",
"MonetaryValue": "in dolore",
"SubType": "ut commodo"
},
{
"Code": "id ",
"CurrencyCode": "des",
"Description": "tempor",
"MonetaryValue": "non ad tempor ",
"SubType": "nulla voluptate"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "tem",
"CurrencyCode": "non",
"Description": "tempor occaecat in aliqua ",
"MonetaryValue": "anim Ut sint ",
"SubType": "amet reprehenderit ut"
},
{
"Code": "est",
"CurrencyCode": "ven",
"Description": "ut laboris dolore",
"MonetaryValue": "labore ut Excepteur",
"SubType": "nisi dolore"
}
],
"RateModifier": [
{
"Amount": "nostrud labore s",
"ModifierDesc": "do occaecat nostrud incididunt laborisanim esseDui",
"ModifierType": "sin"
},
{
"Amount": "in ipsum commodo",
"ModifierDesc": "ametnostrud officia qui aliqua etaliqua veniam Lor",
"ModifierType": "est"
},
{
"Amount": "cupidatat anim d",
"ModifierDesc": "indolore nisilaborum aliquipincididunt dolor proid",
"ModifierType": "ut "
},
{
"Amount": "elitsitdolore of",
"ModifierDesc": "officia dolorereprehenderitveniam culpa ad idvenia",
"ModifierType": "ull"
}
]
},
"RateModifier": [
{
"Amount": "eu enim",
"ModifierDesc": "enim Ut ut c",
"ModifierType": "inc"
},
{
"Amount": "enim",
"ModifierDesc": "irure",
"ModifierType": "adi"
},
{
"Amount": "proiden",
"ModifierDesc": "et mollit dolor",
"ModifierType": "dol"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "eli",
"MonetaryValue": "nulla do"
},
"ShippingLabel": {
"GraphicImage": "dolore",
"GraphicImagePart": [
"eu fugiat",
"aute dolore id officia sit",
"eu in dolore cupidatat laborum",
"deserunt amet velit minim"
],
"HTMLImage": "dolor minim veniam reprehenderit non",
"ImageFormat": {
"Code": "dol",
"Description": "temp"
},
"InternationalSignatureGraphicImage": "qui in mollit quis",
"PDF417": "qui consectetur aliquip"
},
"ShippingReceipt": {
"GraphicImage": "minim",
"ImageFormat": {
"Code": "nisi",
"Description": "sunt Duis"
}
},
"SimpleRate": {
"Code": "cu"
},
"TrackingNumber": "elit nostrud nondo",
"USPSPICNumber": "deserunt tempor aute est"
}
],
"PalletLabel": {
"PalletLabel": "culpa"
},
"RatingMethod": "re",
"ReceiptURL": "aliquip Lorem aliqua",
"RoarRatedIndicator": "in",
"ShipmentCharges": {
"BaseServiceCharge": {
"CurrencyCode": "ani",
"MonetaryValue": "u"
},
"ItemizedCharges": [
{
"Code": "qui",
"CurrencyCode": "Exc",
"Description": "cupidatat tempor Excepteur fugiat ",
"MonetaryValue": "nisi sed",
"SubType": "dolor esse Excepteur elit"
},
{
"Code": "eu ",
"CurrencyCode": "fug",
"Description": "sit in quis",
"MonetaryValue": "occaecat adi",
"SubType": "officia"
}
],
"RateChart": "E",
"ServiceOptionsCharges": {
"CurrencyCode": "lab",
"MonetaryValue": "eu"
},
"TaxCharges": [
{
"MonetaryValue": "anim",
"Type": "ut dolor "
},
{
"MonetaryValue": "laboris",
"Type": "Exce"
},
{
"MonetaryValue": "ipsum laboris",
"Type": "ut"
},
{
"MonetaryValue": "do",
"Type": "ip"
}
],
"TotalCharges": {
"CurrencyCode": "eae",
"MonetaryValue": "mollit"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "mag",
"MonetaryValue": "amet"
},
"TransportationCharges": {
"CurrencyCode": "fug",
"MonetaryValue": "enim"
}
},
"ShipmentIdentificationNumber": "1ZUBDVHKHKKFO34YYL",
"SubProNumber": "pariatur exercitation anim mollit",
"USI": "578299028T"
}
}
}{
"response": {
"errors": [
{
"code": "9",
"message": "System error"
},
{
"code": "2",
"message": "Invalid request parameter"
},
{
"code": "7",
"message": "Invalid request parameter"
},
{
"code": "2",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "8",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "0",
"message": "Authentication failed"
},
{
"code": "1",
"message": "Invalid request parameter"
},
{
"code": "4",
"message": "Invalid request parameter"
},
{
"code": "2",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "Authentication failed"
}
]
}
}DELETE
| Query Parameter Name | Example |
|---|---|
trackingnumber | sint |
| Header Name | Example |
|---|---|
transId | "ad adipisicing tempor" |
transactionSrc | "deserunt dolor cupidatat Lorem" |
{
"VoidShipmentResponse": {
"PackageLevelResults": [
{
"Status": {
"Code": "1",
"Description": "Voided"
},
"TrackingNumber": "1Z3BDPQP0ARPV7H10Q"
},
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZXWPGG0LH6RX5DUAI"
}
],
"Response": {
"Alert": {
"Code": "mol",
"Description": "magna "
},
"ResponseStatus": {
"Code": "a",
"Description": "culpa sed Duis laborum incidi"
},
"TransactionReference": {
"CustomerContext": "ipsum"
}
},
"SummaryResult": {
"Status": {
"Code": "0",
"Description": "Voided"
}
}
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "Invalid request parameter"
},
{
"code": "0",
"message": "System error"
},
{
"code": "9",
"message": "Authentication failed"
},
{
"code": "2",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "System error"
},
{
"code": "1",
"message": "Authentication failed"
},
{
"code": "8",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "1",
"message": "Authentication failed"
},
{
"code": "0",
"message": "Invalid request parameter"
},
{
"code": "6",
"message": "Tracking number not found"
},
{
"code": "5",
"message": "Authentication failed"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "dolore" |
transactionSrc | "aliqua tempor irure enim sint" |
{
"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": "6",
"message": "Invalid request parameter"
},
{
"code": "4",
"message": "Tracking number not found"
},
{
"code": "0",
"message": "Invalid request parameter"
},
{
"code": "4",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "5",
"message": "System error"
},
{
"code": "5",
"message": "System error"
},
{
"code": "4",
"message": "Authentication failed"
},
{
"code": "3",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "6",
"message": "Tracking number not found"
},
{
"code": "8",
"message": "Tracking number not found"
},
{
"code": "3",
"message": "System error"
},
{
"code": "5",
"message": "Invalid request parameter"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "Authentication failed"
},
{
"code": "1",
"message": "Invalid request parameter"
}
]
}
}POST
| Query Parameter Name | Example |
|---|---|
additionaladdressvalidation | laboris dolore et cillum consequat |
| Header Name | Example |
|---|---|
transId | "ut" |
transactionSrc | "Excepteur consequat enim" |
{
"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": "laborum",
"Description": "fugiat commodo ea eiusmod"
},
{
"Code": "Excepte",
"Description": "consectetur aliquip"
},
{
"Code": "of",
"Description": "mollit reprehenderit anim"
},
{
"Code": "do ",
"Description": "enim eiusmod officia ad"
},
{
"Code": "ut ",
"Description": "sit sint enim nisi ex"
}
],
"ResponseStatus": {
"Code": "a",
"Description": "ut exercitation Lorem"
},
"TransactionReference": {
"CustomerContext": "aliqua officia consequat veniam"
}
},
"ShipmentResults": {
"BarCodeImage": "aliquip velit dolor ullamco",
"BillableWeightCalculationMethod": "ir",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "tem",
"Description": "magna"
},
"Weight": "sit labo"
},
"BillOfLading": "cillum",
"CODTurnInPage": {
"Image": {
"GraphicImage": "culpa ut",
"ImageFormat": {
"Code": "vel",
"Description": "pariatur"
}
}
},
"ControlLogReceipt": [
{
"GraphicImage": "sit dolor",
"ImageFormat": {
"Code": "ex",
"Description": "Lorem Duis culpa m"
}
},
{
"GraphicImage": "adipisicing dolore",
"ImageFormat": {
"Code": "in",
"Description": "reprehenderit elit consect"
}
},
{
"GraphicImage": "dolore anim ut",
"ImageFormat": {
"Code": "off",
"Description": "laboris in ad"
}
}
],
"DGPaperImage": [
"veniam culpa aliquip",
"et laboris voluptate laborum dolore",
"nostrud sunt"
],
"Disclaimer": [
{
"Code": "no",
"Description": "officia pariatur"
},
{
"Code": "nu",
"Description": "reprehenderit incididunt deserunt"
}
],
"Form": {
"Code": "in",
"Description": "enim qui amet tempor officia",
"FormGroupId": "minim commodo ex la",
"FormGroupIdName": "consequat incididunt",
"Image": {
"GraphicImage": "nulla commodo ex",
"ImageFormat": {
"Code": "vol",
"Description": "Ut nostrud"
}
}
},
"FRSShipmentData": {
"FreightDensityRate": {
"Density": "ut i",
"TotalCubicFeet": "a"
},
"HandlingUnits": [
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "eu",
"Description": "magna aliqua ut eius"
},
"Value": "in est"
},
"Dimensions": {
"Height": "Excepteur veniam",
"Length": "of",
"UnitOfMeasurement": {
"Code": "of",
"Description": "Lorem"
},
"Width": "eiusmod"
},
"Quantity": "con",
"Type": {
"Code": "pro",
"Description": "ut"
}
},
{
"AdjustedHeight": {
"UnitOfMeasurement": {
"Code": "an",
"Description": "minim ut mo"
},
"Value": "irur"
},
"Dimensions": {
"Height": "sunt ea tempor p",
"Length": "ad a",
"UnitOfMeasurement": {
"Code": "co",
"Description": "Dui"
},
"Width": "i"
},
"Quantity": "est ",
"Type": {
"Code": "off",
"Description": "ut "
}
}
],
"TransportationCharges": {
"DiscountAmount": {
"CurrencyCode": "ull",
"MonetaryValue": "minim esse L"
},
"DiscountPercentage": "dol",
"GrossCharge": {
"CurrencyCode": "min",
"MonetaryValue": "exercitation"
},
"NetCharge": {
"CurrencyCode": "sit",
"MonetaryValue": "eu anim"
}
}
},
"GCCN": "minim id elit",
"HighValueReport": {
"Image": {
"GraphicImage": "incididunt labore",
"ImageFormat": {
"Code": "non",
"Description": "cu"
}
}
},
"LabelURL": "proident",
"LocalLanguageLabelURL": "anim magna",
"LocalLanguageReceiptURL": "in ad occaecat",
"MasterCartonID": "culpa proident nisi offi",
"Message": "esse sit anim ut reprehenderit",
"MIDualReturnShipmentKey": "ut consequat",
"NegotiatedRateCharges": {
"ItemizedCharges": [
{
"Code": "sed",
"CurrencyCode": "ull",
"Description": "in",
"MonetaryValue": "dolore labore",
"SubType": "magna aliquip amet ut nulla"
},
{
"Code": "Ut ",
"CurrencyCode": "et ",
"Description": "magna cillum sit",
"MonetaryValue": "ut aute adipi",
"SubType": "labo"
},
{
"Code": "est",
"CurrencyCode": "ull",
"Description": "exercitation deserunt est velit ut",
"MonetaryValue": "dolor id a",
"SubType": "nostrud"
}
],
"RateModifier": [
{
"Amount": "ipsum exsunt cup",
"ModifierDesc": "ametdolor ut sintlaboris in quilaborumeu Ut qui no",
"ModifierType": "sun"
}
],
"TaxCharges": [
{
"MonetaryValue": "aliquip",
"Type": "aliqua "
}
],
"TotalCharge": {
"CurrencyCode": "nis",
"MonetaryValue": "con"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "non",
"MonetaryValue": "commodo exercit"
}
},
"PackageResults": [
{
"Accessorial": [
{
"Code": "dol",
"Description": "proident"
},
{
"Code": "par",
"Description": "eu cupidatat"
},
{
"Code": "eiu",
"Description": "elit dolore ipsum Duis"
},
{
"Code": "ame",
"Description": "in Duis officia ad minim"
}
],
"BaseServiceCharge": {
"CurrencyCode": "in ",
"MonetaryValue": "veniam ipsum qui"
},
"CN22Number": "dolore deserunt ut voluptate",
"Form": {
"Code": "oc",
"Description": "do",
"FormGroupId": "ad D",
"FormGroupIdName": "aute est non",
"Image": {
"GraphicImage": "ut consectetur enim Lorem dolor",
"ImageFormat": {
"Code": "adi",
"Description": "adipisicing commodo nostrud"
}
}
},
"ItemizedCharges": [
{
"Code": "ull",
"CurrencyCode": "inm",
"Description": "sint elit est dolore ",
"MonetaryValue": "ex ipsum",
"SubType": "id"
},
{
"Code": "occ",
"CurrencyCode": "lab",
"Description": "adipisicing aliqua dolor",
"MonetaryValue": "in",
"SubType": "deserunt elit amet a"
}
],
"NegotiatedCharges": {
"ItemizedCharges": [
{
"Code": "dol",
"CurrencyCode": "off",
"Description": "nulla reprehenderit deserunt ex",
"MonetaryValue": "eu et aliquip",
"SubType": "in culpa"
}
],
"RateModifier": [
{
"Amount": "enim aliqua ex c",
"ModifierDesc": "consectetur deserunt pariaturaute nisiconsecteturm",
"ModifierType": "sin"
}
]
},
"RateModifier": [
{
"Amount": "fugiat id",
"ModifierDesc": "esse",
"ModifierType": "ali"
},
{
"Amount": "qui irure",
"ModifierDesc": "mollit",
"ModifierType": "ess"
},
{
"Amount": "laboris",
"ModifierDesc": "Excepteur",
"ModifierType": "lab"
},
{
"Amount": "do in est proi",
"ModifierDesc": "irure veniam ut anim nisi",
"ModifierType": "dol"
},
{
"Amount": "s",
"ModifierDesc": "ut et",
"ModifierType": "tem"
}
],
"ServiceOptionsCharges": {
"CurrencyCode": "par",
"MonetaryValue": "et"
},
"ShippingLabel": {
"GraphicImage": "enim reprehenderit voluptate",
"GraphicImagePart": [
"consectetur",
"reprehenderit in sit ea"
],
"HTMLImage": "est sunt",
"ImageFormat": {
"Code": "con",
"Description": "exercitation occaecat in"
},
"InternationalSignatureGraphicImage": "ea eiusmod nostrud",
"PDF417": "velit adipisicing voluptate ea"
},
"ShippingReceipt": {
"GraphicImage": "amet",
"ImageFormat": {
"Code": "do ",
"Description": "amet pariatur ut quis nostrud"
}
},
"SimpleRate": {
"Code": "al"
},
"TrackingNumber": "laborum esse et ip",
"USPSPICNumber": "laboris"
}
],
"PalletLabel": {
"PalletLabel": "enim laboris"
},
"RatingMethod": "pa",
"ReceiptURL": "proident",
"RoarRatedIndicator": "sint et",
"ShipmentCharges": {
"BaseServiceCharge": {
"CurrencyCode": "con",
"MonetaryValue": "occaecat consequa"
},
"ItemizedCharges": [
{
"Code": "nos",
"CurrencyCode": "dol",
"Description": "nostrud Ut incididun",
"MonetaryValue": "et pariatur eu la",
"SubType": "aute laboru"
},
{
"Code": "in ",
"CurrencyCode": "ips",
"Description": "cupidatat cillum labore",
"MonetaryValue": "m",
"SubType": "ut laborum do moll"
},
{
"Code": "cup",
"CurrencyCode": "dol",
"Description": "deserunt cupidatat Duis voluptate ex",
"MonetaryValue": "ullamco",
"SubType": "ut aliqua nostrud dolor minim"
},
{
"Code": "par",
"CurrencyCode": "cul",
"Description": "tempor ad veniam est officia",
"MonetaryValue": "nisi do dolo",
"SubType": "voluptate commodo irure anim"
}
],
"RateChart": "n",
"ServiceOptionsCharges": {
"CurrencyCode": "iru",
"MonetaryValue": "irure sint E"
},
"TaxCharges": [
{
"MonetaryValue": "aute",
"Type": "com"
},
{
"MonetaryValue": "sint",
"Type": "labo"
},
{
"MonetaryValue": "commodo",
"Type": "nulla f"
},
{
"MonetaryValue": "et in",
"Type": "dese"
},
{
"MonetaryValue": "commodo ali",
"Type": "cil"
}
],
"TotalCharges": {
"CurrencyCode": "ut ",
"MonetaryValue": "Excepteur enim ci"
},
"TotalChargesWithTaxes": {
"CurrencyCode": "ull",
"MonetaryValue": "qui nis"
},
"TransportationCharges": {
"CurrencyCode": "ali",
"MonetaryValue": "aute labore"
}
},
"ShipmentIdentificationNumber": "1ZX3PGSJ1M2ZHDRL84",
"SubProNumber": "elit in",
"USI": "578299028T"
}
}
}{
"response": {
"errors": [
{
"code": "9",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "6",
"message": "Tracking number not found"
},
{
"code": "7",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "0",
"message": "Invalid request parameter"
},
{
"code": "3",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "4",
"message": "System error"
},
{
"code": "2",
"message": "Invalid request parameter"
},
{
"code": "0",
"message": "Invalid request parameter"
},
{
"code": "1",
"message": "System error"
},
{
"code": "0",
"message": "Tracking number not found"
}
]
}
}DELETE
| Query Parameter Name | Example |
|---|---|
trackingnumber | Excepteur in |
| Header Name | Example |
|---|---|
transId | "cillum laboris commodo enim incididunt" |
transactionSrc | "sunt" |
{
"VoidShipmentResponse": {
"PackageLevelResults": [
{
"Status": {
"Code": "1",
"Description": "Not Voided"
},
"TrackingNumber": "1ZXU9FAB6DYVUCE995"
},
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZVHWSTPUMPHWXOMLR"
},
{
"Status": {
"Code": "0",
"Description": "Not Voided"
},
"TrackingNumber": "1ZCVLPR0GAGLA5O37D"
}
],
"Response": {
"Alert": {
"Code": "qui",
"Description": "ullamco veniam"
},
"ResponseStatus": {
"Code": "q",
"Description": "consectetur in"
},
"TransactionReference": {
"CustomerContext": "culpa cillum Duis"
}
},
"SummaryResult": {
"Status": {
"Code": "1",
"Description": "Already Voided"
}
}
}
}{
"response": {
"errors": [
{
"code": "1",
"message": "Invalid request parameter"
},
{
"code": "9",
"message": "Tracking number not found"
}
]
}
}{
"response": {
"errors": [
{
"code": "7",
"message": "Invalid request parameter"
},
{
"code": "3",
"message": "System error"
}
]
}
}{
"response": {
"errors": [
{
"code": "2",
"message": "Invalid request parameter"
},
{
"code": "3",
"message": "Invalid request parameter"
},
{
"code": "2",
"message": "Authentication failed"
}
]
}
}{
"response": {
"errors": [
{
"code": "3",
"message": "Tracking number not found"
},
{
"code": "1",
"message": "System error"
},
{
"code": "9",
"message": "Tracking number not found"
},
{
"code": "2",
"message": "Tracking number not found"
}
]
}
}Service Homepage: github.com/UPS-API/api-documentation/blob/main/Shipping.yaml
upsshippinglogisticsecommercerest