UPS Forwarding API Virtual Sandbox
Unified RESTful interface for managing ocean and air freight shipments.
The UPS Forwarding API links the UPS Forwarding Hub to backend applications, enabling the management of ocean and air freight shipments. It provides near real-time rate quotes, booking capabilities, and shipment tracking tools to streamline logistics operations and improve visibility.
Use this hosted sandbox to simulate UPS Forwarding API 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 freight shipment workflows, including rate quote requests, booking submissions, document generation for labels and manifests, and tracking milestone updates. Developers can test payload structures, error handling for invalid shipment data, and integration logic for air and ocean freight logistics.
Forwarding(22 operations)
POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"shipper": {
"company": "Philip",
"account": "123456789",
"address1": "12380 MORRIS RD",
"city": "SHREWSBURY",
"state": "NJ",
"postalCode": "7702",
"countryCode": "US",
"serviceCenterCode": "SDF",
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"contactName": "Michael",
"contactPhone": "999999999",
"contactEmail": "test@gmail.com",
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
"consignee": {
"company": "Ship To Philip",
"account": "123456789",
"address1": "12380 MORRIS RD",
"city": "SHREWSBURY",
"state": "NJ",
"postalCode": "07102",
"countryCode": "US",
"serviceCenterCode": "SDF",
"partyCode": "CID987654321",
"contactName": "Sarah",
"contactPhone": "888888888",
"contactEmail": "sarah@example.com",
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
"thirdParty": {
"company": "Third Party Logistics",
"account": "123456789",
"address1": "7890 LOGISTICS RD",
"city": "ATLANTA",
"state": "GA",
"postalCode": "30303",
"countryCode": "US",
"serviceCenterCode": "ATL",
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"contactName": "John",
"contactPhone": "777777777",
"contactEmail": "john@example.com",
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
"shipment": {
"shipmentNumber": "9100010271",
"serviceType": "AM",
"paymentType": "PPD",
"pickupDate": "2025-04-24T00:00:00.000Z",
"readyTime": "09:15:59",
"closeTime": 61379,
"dropoffTime": 64800,
"weight": 54,
"freightType": "PALLET",
"isMetric": false,
"orderDescription": "Shipment of electronics",
"shipperReference": "SHIP123",
"consigneeReference": "CON123",
"currencyCode": "USD",
"requestPickup": true,
"requestBoL": true,
"countryOfManufacture": [
"US",
"MX",
"CA"
],
"items": [
{
"description": "Laptop",
"count": 1,
"length": 15,
"width": 10,
"height": 1,
"weight": 5,
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
{
"description": "Monitor",
"count": 1,
"length": 24,
"width": 18,
"height": 5,
"weight": 15,
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
}
],
"details": [
{
"key": "IsHazmat",
"value": "true"
},
{
"key": "IsHazmatPassengerAircraft",
"value": "true"
},
{
"key": "IsHAPU",
"value": "true"
},
{
"key": "DeclaredValue",
"value": "1000"
},
{
"key": "DeclaredValueCurrencyCode",
"value": "USD"
},
{
"key": "CustomsValue",
"value": "1000"
},
{
"key": "CustomsValueCurrencyCode",
"value": "USD"
},
{
"key": "IsSaturdayPickup",
"value": "false"
},
{
"key": "IsCustomsClearance",
"value": "false"
},
{
"key": "IsFreeDomicileDDU",
"value": "false"
},
{
"key": "IsFreeDomicileDDP",
"value": "false"
}
]
},
"language": "en-US",
"transactionId": "TXT123432"
}{
"response": {
"rates": [
{
"serviceType": "AM",
"guaranteedDelivery": true,
"deliveryTime": "2025-05-14 12:00:00Z",
"holdAtAirportTime": "2025-05-14 17:00:00Z",
"totalCharge": {
"amount": "1170.71",
"currencyCode": "USD"
},
"billableWeight": 151,
"weightUnit": "LBS",
"dimensionalWeight": 47,
"minimumBillableWeightApplied": true,
"contractRate": false,
"charges": [
{
"role": "Carrier",
"code": "FRT",
"description": "Air Freight Shipping - Included",
"amount": 250.75,
"currencyCode": "USD"
},
{
"role": "Agent",
"code": "FEE",
"description": "Fuel Surcharge - Included",
"amount": 45,
"currencyCode": "USD"
}
]
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"shipper": {
"account": "000990879",
"serviceCenterCode": "PDX",
"contactName": "Subaru",
"contactPhone": "541813846",
"contactEmail": "subaru@ups.com",
"company": "SUBARU OF AMERICA",
"address1": "1410 N LOMBARD ST",
"city": "PORTLAND",
"state": "OR",
"postalCode": "97203",
"countryCode": "US"
},
"consignee": {
"account": null,
"serviceCenterCode": "MAA",
"contactName": "Harry",
"contactPhone": "8885888778",
"contactEmail": "HarryTest@ups.com",
"details": [
{
"key": "ConsolidationId",
"value": "ConsolidationTest"
}
],
"company": "Sunrise Logistics Ltd",
"address1": "45 Greenway Drive",
"city": "Chennai",
"state": "TN",
"postalCode": "600119",
"countryCode": "IN"
},
"thirdParty": {
"account": "3206YY",
"serviceCenterCode": "BOS",
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"contactName": "Hardy",
"contactPhone": "999999999",
"contactEmail": "test3@ups.com",
"details": [
{
"key": "Landmark",
"value": "Besides Ammy Library"
},
{
"key": "AlternateNumber",
"value": "9853325341"
}
],
"company": "ABC LTD.",
"address1": "52 June Street",
"address2": "",
"address3": "",
"city": "Cranston",
"state": "RI",
"postalCode": "02920",
"countryCode": "US"
},
"shipment": {
"shipmentNumber": "9100010271",
"serviceType": "CA",
"paymentType": "PPD",
"pickupDate": "2026-01-09T00:00:00.000Z",
"readyTime": 72000,
"closeTime": 79200,
"dropoffTime": 75600,
"weight": 54,
"freightType": "PALLET",
"orderDescription": "WIDGETS",
"shipperReference": "ABC123",
"consigneeReference": "Z30010021",
"currency": "USD",
"isMetric": false,
"items": [
{
"itemDescription": "White Leather Men's Sneakers",
"count": 1,
"length": 10,
"width": 18,
"height": 10,
"weight": 26,
"details": [
{
"key": "CostPerUnit",
"value": "3000"
},
{
"key": "SerialNumber",
"value": "1232212"
}
]
},
{
"itemDescription": "Green floral midi female dress.",
"count": 1,
"length": 10,
"width": 18,
"height": 10,
"weight": 26
}
],
"countryOfManufacture": [
"US",
"MX",
"CA",
"GB"
],
"details": [
{
"key": "IsHazMat",
"value": "false"
},
{
"key": "IsHAPU",
"value": "true"
},
{
"key": "IsSaturdayPickup",
"value": "false"
},
{
"key": "IsCustomsClearance",
"value": "false"
},
{
"key": "CustomsValue",
"value": "10"
},
{
"key": "CustomsValueCurrencyCode",
"value": "USD"
},
{
"key": "DeclaredValue",
"value": "1000"
},
{
"key": "DeclaredValueCurrencyCode",
"value": "USD"
},
{
"key": "PICKUP",
"value": "true"
},
{
"key": "IsFreeDomicileDDU",
"value": "false"
},
{
"key": "IsFreeDomicileDDP",
"value": "false"
},
{
"key": "RESPU",
"value": "true"
},
{
"key": "IsLiftgatePickup",
"value": "true"
},
{
"key": "IsLiftgateDelivery",
"value": "true"
},
{
"key": "IsHazMatPassengerAircraft",
"value": "true"
},
{
"key": "HAZMAT-Instruction",
"value": "Lithium Battery"
},
{
"key": "ContactName",
"value": "Mike"
},
{
"key": "ContactPhone",
"value": "000-123-4567"
},
{
"key": "IsDoorDelivery",
"value": "false"
},
{
"key": "GovernmentBoLNumber",
"value": "BoL-00786"
},
{
"key": "RemarksToConsignee",
"value": "Handle with care"
}
]
},
"label": {
"layout": "AF-GEMINI",
"format": "PDF",
"details": [
{
"key": "model_number",
"value": "123543"
},
{
"key": "model_year",
"value": "2023"
}
]
},
"language": "en-US",
"transId": "TXN123456789"
}{
"response": {
"shipmentNumber": "9100010271",
"orderNumber": "9100010270001",
"labelFormat": "DATA",
"charges": {
"shipperCharges": [
{
"code": "AF",
"description": "Air Freight",
"amount": "10.00",
"currencyCode": "USD"
}
],
"consigneeCharges": [
{
"code": "DL",
"description": "Delivery Charges",
"amount": "10.00",
"currencyCode": "USD"
}
]
},
"labelData": {
"shipper": {
"company": "ABC Inc",
"address1": "123 Som St",
"city": "Atlanta",
"state": "GA",
"postalCode": "30005",
"countryCode": "US",
"account": "123456789",
"serviceCenterCode": "ATL",
"contactName": "Zeus",
"contactPhone": "8888888888",
"contactEmail": "test1@ups.com"
},
"consignee": {
"company": "ABC Inc",
"address1": "123 Som St",
"city": "Atlanta",
"state": "GA",
"postalCode": "30005",
"countryCode": "US",
"account": "123456789",
"serviceCenterCode": "ATL",
"contactName": "Zeus",
"contactPhone": "8888888888",
"contactEmail": "test1@ups.com"
},
"shipment": {
"shipmentNumber": "9100010271",
"serviceType": "AM",
"paymentType": "PPD",
"pickupDate": "2025-10-22T00:00:00.000Z",
"readyTime": 39600,
"closeTime": 61200,
"dropoffTime": 40200,
"weight": 54,
"freightType": "PALLET",
"orderDescription": "Apparels",
"shipperReference": "Z30010021",
"consigneeReference": "ABC123",
"currency": "USD",
"isMetric": "0",
"countryOfManufacture": [
"US",
"MX",
"CA",
"GB"
],
"details": [
{
"key": "IsHazMat",
"value": "false"
},
{
"key": "IsHAPU",
"value": "true"
},
{
"key": "IsSaturdayPickup",
"value": "false"
},
{
"key": "IsCustomsClearance",
"value": "false"
},
{
"key": "CustomsValue",
"value": "0"
},
{
"key": "CustomsValueCurrencyCode",
"value": "USD"
},
{
"key": "DeclaredValue",
"value": "1000"
},
{
"key": "DeclaredValueCurrencyCode",
"value": "USD"
},
{
"key": "PICKUP",
"value": "true"
},
{
"key": "IsFreeDomicileDDU",
"value": "false"
},
{
"key": "IsFreeDomicileDDP",
"value": "false"
},
{
"key": "RESPU",
"value": "true"
},
{
"key": "IsLiftgatePickup",
"value": "true"
},
{
"key": "IsLiftgateDelivery",
"value": "true"
},
{
"key": "IsHazMatPassengerAircraft",
"value": "true"
},
{
"key": "HAZMAT-Instruction",
"value": "Lithium Battery"
},
{
"key": "ContactName",
"value": "Mike"
},
{
"key": "ContactPhone",
"value": "000-123-4567"
},
{
"key": "IsDoorDelivery",
"value": "false"
},
{
"key": "GovernmentBoLNumber",
"value": "BoL-00786"
},
{
"key": "RemarksToConsignee",
"value": "Handle with care"
}
],
"rates": {
"amount": 1526.74,
"currencyCode": "USD"
},
"sortCode": "U-BOS",
"gateway": "ATL",
"count": 2,
"labelService": "ND",
"serviceDesc": "UPS Next Day Air Freight - NGS"
}
},
"warnings": [
{
"code": "1050",
"message": "Consignee Contact Name too long"
}
],
"message": "Order created successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}DELETE
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"account": "123456789",
"orderNumber": "3912088430001",
"language": "en-US"
}{
"response": {
"shipmentNumber": "9100010271",
"orderNumber": "9100010270001",
"message": "Order cancelled successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Order Not Found"
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}PATCH
| Query Parameter Name | Example |
|---|---|
shipper_account_number* | 123456789 |
order_number | 3912088430001 |
old_date | 2026-07-06 |
language | en-US |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
[
{
"op": "replace",
"path": "/newDate",
"value": "2025-07-24T00:00:00.000Z"
}
]{
"response": {
"shipmentNumber": "910001027",
"orderNumber": "9100010270001",
"newDate": "2025-10-22T00:00:00.000Z",
"message": "Pickup date set successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
criteria* | {"criteriaList":[{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},null,{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}},null,{"criteriaField":"SHIP_DATE","criteriaOperator":"BTWN","criteriaValue":"8","criteriaValue2":{}}],"language":"en-US","shipperAccountNumber":"123456789"} |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"orders": [
{
"shipmentNumber": "906694886",
"orderNumber": "9066948860001",
"consignee": {
"account": "123456789",
"serviceCenterCode": "BOS",
"contactName": "Sheldon",
"contactPhone": "8888888778",
"contactEmail": "test2@ups.com",
"company": "DHL INTERNATIONAL (UK) LTD.",
"address1": "99 Hereford Street",
"city": "Cranston",
"state": "RI",
"postalCode": "02920",
"countryCode": "US"
},
"shipDate": "2025-07-24T00:00:00.000Z",
"statusCode": 8,
"status": "Posted",
"description": "LOTS OF STUFF",
"manifestNumber": "M934567890",
"shipperReference": "SHIPPER REF",
"consigneeReference": "CONSIGNEE REF",
"isMetric": true,
"items": {
"totalWeight": 14,
"weightUnit": "LB",
"totalPieceCount": 2,
"item": [
{
"count": 1,
"length": 10,
"width": 10,
"height": 10,
"weight": 10
},
{
"count": 1,
"length": 10,
"width": 10,
"height": 10,
"weight": 10
}
]
}
}
],
"message": "Order search completed successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"shipperAccountNumber": "123456789",
"orderNumber": "9100005950005",
"format": "PDF",
"layout": "AF-GEMINI"
}{
"response": {
"labelFormat": "PDF",
"shipmentNumber": "9100010271",
"orderNumber": "9100010270001",
"charges": {
"shipperCharges": [
{
"code": "AF",
"description": "Air Freight",
"amount": "10.00",
"currencyCode": "USD"
}
],
"consigneeCharges": [
{
"code": "DL",
"description": "Delivery Charges",
"amount": "10.00",
"currencyCode": "USD"
}
]
},
"labelImage": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg==",
"labelData": {
"shipper": {
"company": "ABC Inc",
"address1": "123 Som St",
"city": "Atlanta",
"state": "GA",
"postalCode": "30005",
"countryCode": "US",
"account": "123456789",
"serviceCenterCode": "ATL",
"contactName": "Zeus",
"contactPhone": "8888888888",
"contactEmail": "test1@ups.com"
},
"consignee": {
"company": "ABC Inc",
"address1": "123 Som St",
"city": "Atlanta",
"state": "GA",
"postalCode": "30005",
"countryCode": "US",
"account": "123456789",
"serviceCenterCode": "ATL",
"contactName": "Zeus",
"contactPhone": "8888888888",
"contactEmail": "test1@ups.com"
},
"shipment": {
"shipmentNumber": "9100010271",
"serviceType": "AM",
"paymentType": "PPD",
"pickupDate": "2025-10-22T00:00:00.000Z",
"readyTime": 39600,
"closeTime": 61200,
"dropoffTime": 40200,
"weight": 54,
"freightType": "PALLET",
"orderDescription": "Apparels",
"shipperReference": "Z30010021",
"consigneeReference": "ABC123",
"currency": "USD",
"isMetric": "0",
"countryOfManufacture": [
"US",
"MX",
"CA",
"GB"
],
"details": [
{
"key": "IsHazMat",
"value": "false"
},
{
"key": "IsHAPU",
"value": "true"
},
{
"key": "IsSaturdayPickup",
"value": "false"
},
{
"key": "IsCustomsClearance",
"value": "false"
},
{
"key": "CustomsValue",
"value": "0"
},
{
"key": "CustomsValueCurrencyCode",
"value": "USD"
},
{
"key": "DeclaredValue",
"value": "1000"
},
{
"key": "DeclaredValueCurrencyCode",
"value": "USD"
},
{
"key": "PICKUP",
"value": "true"
},
{
"key": "IsFreeDomicileDDU",
"value": "false"
},
{
"key": "IsFreeDomicileDDP",
"value": "false"
},
{
"key": "RESPU",
"value": "true"
},
{
"key": "IsLiftgatePickup",
"value": "true"
},
{
"key": "IsLiftgateDelivery",
"value": "true"
},
{
"key": "IsHazMatPassengerAircraft",
"value": "true"
},
{
"key": "HAZMAT-Instruction",
"value": "Lithium Battery"
},
{
"key": "ContactName",
"value": "Mike"
},
{
"key": "ContactPhone",
"value": "000-123-4567"
},
{
"key": "IsDoorDelivery",
"value": "false"
},
{
"key": "GovernmentBoLNumber",
"value": "BoL-00786"
},
{
"key": "RemarksToConsignee",
"value": "Handle with care"
}
],
"rates": {
"amount": 1526.74,
"currencyCode": "USD"
},
"sortCode": "U-BOS",
"gateway": "ATL",
"count": 2,
"labelService": "ND",
"serviceDesc": "UPS Next Day Air Freight - NGS"
}
},
"message": "Label generated successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}PATCH
| Query Parameter Name | Example |
|---|---|
shipper_account_number* | 123456789 |
pickup_date | 2026-07-08 |
request_manifest | true |
manifest_format | PDF |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
[
{
"op": "replace",
"path": "/status",
"value": "submitted"
}
]{
"response": {
"account": "123456789",
"pickupDate": "2025-07-24T00:00:00.000Z",
"shipmentCount": 1,
"pieceCount": 2,
"weight": 200,
"weightUnit": "LBS",
"manifest": {
"manifestNumber": "M810000091",
"manifestFormat": "DATA",
"shipper": {
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"company": "GEMINI SYSTEM INFORMATION",
"address1": "12380 MORRIS RD",
"city": "Louisville",
"state": "KY",
"postalCode": "40214",
"countryCode": "US"
},
"shipments": [
{
"number": 1,
"shipmentNumber": "9100010271",
"serviceType": "AM",
"paymentType": "OTH/THD",
"weight": 54,
"currency": "USD",
"shipperReference": "36566355",
"consigneeReference": "BATCH NO: B35",
"consignee": {
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"company": "DHL INTERNATIONAL (UK) LTD.",
"address1": "99 Hereford Street",
"address2": "",
"address3": "",
"city": "Cranston",
"state": "RI",
"postalCode": "02920",
"countryCode": "US"
}
}
],
"summary": {
"services": [
{
"serviceCode": "CX",
"serviceName": "UPS Express® Freight",
"freightChargesAmount": 24.45,
"surchargesAmount": 45.87,
"addedChargesAmount": 33.2,
"billedAmount": 55,
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
},
{
"serviceCode": "D2",
"serviceName": "UPS 2nd Day Air® Freight NGS",
"freightChargesAmount": 24.45,
"surchargesAmount": 45.87,
"addedChargesAmount": 33.2,
"billedAmount": 45.2,
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
}
],
"serviceTotal": {
"freightChargesAmount": 24.45,
"surchargesAmount": 45.87,
"addedChargesAmount": 33.2,
"billedAmount": 100.2,
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 4
},
"dailyPickupTotals": {
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 4
},
"currentPickupTotals": {
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 4
}
}
},
"message": "Shipments submitted successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}DELETE
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"shipperAccountNumber": "123456789",
"shipmentNumber": "391208843",
"language": "en-US"
}{
"response": {
"shipperAccountNumber": "123456789",
"shipmentNumber": "9100010271",
"message": "Shipment cancelled successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "The requested resource was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"shipper": {
"account": "123456789",
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"countryCode": "US",
"serviceCenterCode": "NYC",
"partyCode": "SHIP123",
"company": "Shipper Inc",
"contactName": "John Doe",
"contactPhone": "+1-555-1234",
"contactEmail": "john.doe@shipper.com",
"partySectionDetails": [
{
"key": "part",
"value": "p434567"
}
],
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
"consignee": {
"account": "999999999",
"address1": "456 Market St",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"countryCode": "US",
"serviceCenterCode": "SFO",
"partyCode": "CON123",
"company": "Consignee LLC",
"contactName": "Jane Smith",
"contactPhone": "+1-555-5678",
"contactEmail": "jane.smith@consignee.com",
"partySectionDetails": [
{
"key": "department",
"value": "Receiving"
}
],
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
"thirdParty": {
"company": "Third Party Logistics",
"account": "123456789",
"address1": "7890 LOGISTICS RD",
"city": "ATLANTA",
"state": "GA",
"postalCode": "30303",
"countryCode": "US",
"serviceCenterCode": "ATL",
"partyCode": "CID-123456789",
"contactName": "John",
"contactPhone": "777777777",
"contactEmail": "john@example.com",
"partySectionDetails": [
{
"key": "part",
"value": "p434567"
}
],
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
"shipment": {
"serviceType": "AM",
"paymentType": "PPD",
"pickupDate": "2025-08-11",
"readyTime": "09:00:00",
"closeTime": "17:00:00",
"dropoffTime": "16:00:00",
"weight": 25.5,
"freightType": "PALLET",
"isMetric": true,
"orderDescription": "Electronics shipment",
"shipperReference": "REF123",
"consigneeReference": "CREF456",
"currency": "USD",
"requestPickup": true,
"requestBoL": false,
"countryOfManufacture": [
"US"
],
"items": [
{
"description": "Laptop",
"count": 10,
"length": 38.5,
"width": 25,
"height": 2.5,
"weight": 2,
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
},
{
"description": "Monitor",
"count": 5,
"length": 60,
"width": 35,
"height": 8,
"weight": 5.5,
"details": [
{
"key": "serialNumber",
"value": "SN654321"
}
]
}
],
"details": [
{
"key": "DV",
"value": "1000"
},
{
"key": "DV-Currency",
"value": "USD"
},
{
"key": "HAZMAT",
"value": "true"
},
{
"key": "CV",
"value": "1000"
},
{
"key": "CV-Currency",
"value": "USD"
},
{
"key": "CC",
"value": "true"
},
{
"key": "DLV",
"value": "true"
},
{
"key": "DDU",
"value": "true"
},
{
"key": "DDP",
"value": "true"
},
{
"key": "RESPU",
"value": "true"
},
{
"key": "RESDLV",
"value": "true"
},
{
"key": "LIFTGTPU",
"value": "true"
},
{
"key": "PICKUP",
"value": "true"
},
{
"key": "IsHazmat",
"value": "true"
},
{
"key": "IsHazmatPassengerAircraft",
"value": "true"
},
{
"key": "HAPU",
"value": "true"
}
]
},
"label": {
"layout": "AF-GEMINI",
"format": "PDF",
"details": {
"PieceCount": "3",
"Model_Number": "X",
"Model_Year": "2023",
"Shipper_ReferenceNo": "SHP2401-A3MC220",
"FCSD_Part": "123456",
"FCSD_PartNumber\"": "PN-98765",
"FCSD_PartDescription\"": "Widget Assembly",
"FCSD_Dealer": "ABC Motors",
"NAGS_Part": "1234566",
"NAGS_PartNumber": "NAGS-12345",
"NAGS_PartDescription": "Glass Panel",
"NAGS_Dealer": "XYZ Glassworks",
"Y-Release": "Yes",
"PO": "PO-12345",
"DOR": "DOR-67890"
}
},
"language": "en-us",
"transactionId": "txn-0016ty675r5"
}{
"response": {
"shipmentNumber": "986756456T",
"prqNumber": "PRQ123456",
"prqStatus": "CONFIRMED",
"originServiceCenter": "NYC",
"destinationServiceCenter": "SFO",
"paymentType": "PPD",
"rates": [
{
"serviceType": "AM",
"guaranteedDelivery": true,
"deliveryTime": "2025-08-12T10:00:00Z",
"holdAtAirportTime": "2025-08-12T12:00:00Z",
"totalCharge": 150.75,
"currency": "USD",
"billableWeight": 30,
"weightUnit": "KG",
"dimensionalWeight": 28,
"minimumBillableWeightApplied": false,
"contractRate": false,
"charges": [
{
"role": "SHPR",
"code": "FRT",
"description": "Freight Charge",
"amount": 120,
"currency": "USD"
},
{
"role": "SHPR",
"code": "FSC",
"description": "Fuel Surcharge",
"amount": 30.75,
"currency": "USD"
}
]
}
]
},
"label": {
"format": "PDF",
"layout": "AF-GEMINI",
"image": "Base64EncodedPDF"
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
request_type* | Ocean |
shipment_id* | 200025511 |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"shipmentSummary": {
"shipmentNumber": null,
"confirmationId": "374680504",
"quoteIdentificationNumber": "200025511",
"status": "ShipmentConfirmed",
"serviceLine": "LCL",
"serviceType": "PF",
"serviceGroup": null,
"movementType": "DTD",
"movementTypeCode": "DTA",
"rateType": "Market",
"transitTime": 16,
"validTill": "2024-12-24T00:00:00Z",
"validity": 7,
"portOfLoad": "DEP01",
"portOfDischarge": "USP0B",
"createdDate": "2024-12-17T05:19:25.7966667Z",
"incoTermType": "DAP",
"originPort": {
"code": "DEHAM",
"name": "HAMBURG"
},
"destinationPort": {
"code": "USNYC",
"name": "NEW YORK"
},
"paymentTerm": {
"code": "PPD",
"type": "SHPR"
},
"partyDetails": [
{
"type": "SHPR",
"accountNumber": null,
"isPayor": true,
"contactDetail": {
"name": null,
"emailAddress": null,
"faxNumber": null,
"phoneNumber": null,
"referenceNumber": null
},
"address": {
"companyName1": null,
"companyName2": null,
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"city": "HAMBURG",
"stateCode": null,
"postalCode": null,
"countryCode": "DE",
"companyName": null,
"fullAddress": null
}
},
{
"type": "CONS",
"accountNumber": null,
"isPayor": false,
"contactDetail": {
"name": null,
"emailAddress": null,
"faxNumber": null,
"phoneNumber": null,
"referenceNumber": null
},
"address": {
"companyName1": null,
"companyName2": null,
"addressLine1": null,
"addressLine2": null,
"addressLine3": null,
"city": "NEW YORK",
"stateCode": "NY",
"postalCode": "10000",
"countryCode": "US",
"companyName": null,
"fullAddress": null
}
}
],
"cargoDetails": {
"insuredValueCurrency": "USD",
"insuredValue": 5600,
"customsValueCurrency": "USD",
"customsValue": 5600,
"commodityName": "Leather Dressings",
"fclCargoItems": [],
"cargoItems": [
{
"quantity": 11,
"packageType": "Pallets",
"packageTypeCode": "PLT",
"weightDetail": {
"weight": 12,
"unitOfMeasurement": "kg"
},
"dimensions": {
"length": 1.1,
"width": 1.1,
"height": 0.2,
"unitOfMeasurement": "M"
}
}
]
},
"pickupDetail": {
"date": null,
"startTime": null,
"endTime": null
},
"chargeDetails": [
{
"shipmentPartyType": "SHPR",
"charges": [
{
"chargeType": "OF1",
"description": "OCEAN FRT. LCL",
"chargeAmount": 1153.53,
"currency": "USD"
},
{
"chargeType": "774",
"description": "FUEL SURCHARGE - DEST",
"chargeAmount": 346.06,
"currency": "USD"
},
{
"chargeType": "PU",
"description": "PICK UP",
"chargeAmount": 215.38,
"currency": "USD"
},
{
"chargeType": "90",
"description": "EXPORT CUSTOMS CLEARANCE FEE",
"chargeAmount": 59.23,
"currency": "USD"
},
{
"chargeType": "D95",
"description": "ISF FILING FEE NVO",
"chargeAmount": 50,
"currency": "USD"
},
{
"chargeType": "777",
"description": "FUEL SURCHARGE - ORIG",
"chargeAmount": 43.08,
"currency": "USD"
},
{
"chargeType": "568",
"description": "AMS FEE",
"chargeAmount": 35,
"currency": "USD"
},
{
"chargeType": "IN",
"description": "INSURANCE",
"chargeAmount": 25,
"currency": "USD"
}
]
},
{
"shipmentPartyType": "CONS",
"charges": [
{
"chargeType": "07",
"description": "CUSTOMS BROKERAGE CHARGE - DEST",
"chargeAmount": 145,
"currency": "USD"
}
]
},
{
"shipmentPartyType": "THRD",
"charges": []
}
]
}
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"accountNumber": "123456789",
"manifestNumber": "M810000079",
"manifestFormat": "DATA",
"language": "en-US"
}{
"response": {
"account": "123456789",
"pickupDate": "2025-07-24T00:00:00.000Z",
"shipmentCount": 1,
"pieceCount": 2,
"weight": 200,
"weightUnit": "LBS",
"manifest": {
"manifestNumber": "M810000091",
"manifestFormat": "DATA",
"shipper": {
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"company": "GEMINI SYSTEM INFORMATION",
"address1": "12380 MORRIS RD",
"address2": "",
"address3": "",
"city": "Louisville",
"state": "KY",
"postalCode": "40214",
"countryCode": "US"
},
"shipments": [
{
"number": 1,
"shipmentNumber": "9100010271",
"serviceType": "AM",
"paymentType": "OTH/THD",
"weight": 54,
"orderDescription": "Lots of Stuff",
"currency": "USD",
"shipperReference": "Z30010021",
"consigneeReference": "ABC123",
"consignee": {
"partyCode": "899df6b43f5b5a7d41db2b8d4759c1e0",
"company": "DHL INTERNATIONAL (UK) LTD.",
"address1": "99 Hereford Street",
"address2": "",
"address3": "",
"city": "Cranston",
"state": "RI",
"postalCode": "02920",
"countryCode": "US"
}
}
],
"summary": {
"services": [
{
"serviceCode": "CX",
"serviceName": "UPS Express® Freight",
"freightChargesAmount": 24.45,
"surchargesAmount": 45.87,
"addedChargesAmount": 33.2,
"billedAmount": 55,
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
},
{
"serviceCode": "D2",
"serviceName": "UPS 2nd Day Air® Freight NGS",
"freightChargesAmount": 24.45,
"surchargesAmount": 45.87,
"addedChargesAmount": 33.2,
"billedAmount": 45.2,
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
}
],
"serviceTotal": {
"freightChargesAmount": 24.45,
"surchargesAmount": 45.87,
"addedChargesAmount": 33.2,
"billedAmount": 100.2,
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
},
"dailyPickupTotals": {
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
},
"currentPickupTotals": {
"shipmentCount": 1,
"itemCount": 1,
"totalWeight": 20,
"pieceCount": 2
}
}
},
"message": "Manifest generated successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-9999",
"message": "The requested resource was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
shipper_account_number | velit |
country* | dolor |
city | incididunt adipisicing magna |
criteria_operator | esse proident elit et labore |
postal | occaecat |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"cityDetails": [
{
"stateProvinceCode": "GA",
"cityName": "ATLANTA",
"majorAirportCity": "YVR",
"tariffDestination": "ATL",
"sortCode": "V1",
"standardService": "BND"
}
],
"message": "Cities fetched successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-9999",
"message": "The requested resource was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
shipper_account_number | id minim |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"currencies": [
{
"currencyCode": "USD",
"currencyName": "United States Dollar"
}
],
"message": "Currencies retrieved successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-9999",
"message": "The requested resource was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
shipper_account_number* | Excepteur in ut dolor labore |
code | fugiat aliqua dolore |
incoterm_code | aliqua in exercitation deserunt ipsum |
movement_type_code | irure amet aute nisi |
origin_country_code | aute deserunt adipisicing |
destination_country_code | amet fugiat reprehenderit culpa |
service_line | est aliqua fugiat dolore |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"paymentTypes": [
{
"code": "PPD",
"description": "Invoice to the shipper",
"incoTermCode": "CIP",
"type": "SHPR",
"movementTypeCode": "ATA",
"serviceGroupName": "NAAF",
"serviceLine": "AIR"
},
{
"code": "OTH/CON",
"description": "Third-Party Payor",
"incoTermCode": "FOB",
"type": "THRD",
"movementTypeCode": "ATD",
"serviceGroupName": "IAF",
"serviceLine": "AIR"
}
],
"message": "Payment types retrieved successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-9999",
"message": "The requested resource was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
shipper_account_number | pariatur |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"countries": [
{
"countryCode": "US",
"countryName": "United States"
}
],
"message": "Countries retrieved successfully."
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-9999",
"message": "The requested resource was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
country_code* | US |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"airportDetails": [
{
"city": "New York",
"airportCode": "JFK",
"postalCode": "11430",
"stateProvince": "NY"
},
{
"city": "Los Angeles",
"airportCode": "LAX",
"postalCode": "90045",
"stateProvince": "CA"
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
shipper_city | Atlanta |
shipper_state_code | GA |
shipper_postal_code | 30301 |
shipper_country_code | US |
consignee_city | London |
consignee_state_code | LN |
consignee_postal_code | SW1A1AA |
consignee_country_code* | GB |
shipper_account_number | 123456789 |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"serviceTypes": [
{
"code": "AMG",
"description": "UPS NEXT DAY AIR FREIGHT"
},
{
"code": "DF",
"description": "UPS 3 DAY FREIGHT NGS"
}
]
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Invalid request"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"shipper": {
"city": "Prague",
"state": "NJ",
"postalCode": "7702",
"countryCode": "CZ",
"isResidential": "Y"
},
"consignee": {
"city": "TIMONIUM",
"state": "NJ",
"postalCode": "7702",
"countryCode": "US",
"isResidential": "Y"
},
"serviceCode": "CA",
"pickupDateTime": "2025-08-11",
"dropOffTime": "01:14:30"
}{
"response": {
"accessorials": [
{
"code": "CC",
"name": "CUSTOMS CLEARANCE"
},
{
"code": "CV",
"name": "CUSTOMS VALUE"
},
{
"code": "DDU",
"name": "DESTINATION DUTIES UNPAID"
},
{
"code": "DLV",
"name": "DELIVERY"
},
{
"code": "DV",
"name": "DECLARED/INSURED VALUE"
},
{
"code": "DDP",
"name": "FREE DOMICILE AVAILABLE"
},
{
"code": "LIFTGT",
"name": "LIFT GATE"
}
],
"paymentTerms": [
{
"type": "SHPR",
"code": "COL",
"desc": "COLLECT SHIPMENTS ALLOWED"
},
{
"type": "SHPR",
"code": "PPD",
"desc": "PREPAID"
},
{
"type": "THRD",
"code": "COL",
"desc": "THIRD"
}
],
"nextAvailPUDate": "2026-01-09"
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}POST
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"requestType": "Air",
"quoteData": {
"serviceType": "DF",
"serviceLine": "Air",
"currencyCode": "USD",
"movementTypeCode": "DTD",
"incoTermType": "EXW",
"importCustomsBrokerageFee": "",
"exportCustomsBrokerageFee": "",
"paymentTerm": {
"type": "THRD",
"code": "OTH/CON"
}
},
"routing": {
"origin": {
"portCode": ""
},
"destination": {
"portCode": ""
},
"specialHandlings": []
},
"shipmentDetails": {
"insuredValueCurrency": "USD",
"insuredValue": 0,
"customsValueCurrency": "USD",
"customsValue": 0,
"commodityName": "Book",
"cargoItems": [
{
"quantity": 1,
"packageType": "Pallet",
"packageTypeCode": "PLT",
"weight": {
"weight": 5,
"unitOfMeasurement": "LB"
},
"dimensions": {
"length": 3,
"width": 8,
"height": 3,
"unitOfMeasurement": "in"
},
"fclCargoItems": []
},
{
"quantity": 1,
"packageType": "Pallet",
"packageTypeCode": "PLT",
"weight": {
"weight": 2,
"unitOfMeasurement": "LB"
},
"dimensions": {
"length": 1,
"width": 8,
"height": 4,
"unitOfMeasurement": "in"
},
"fclCargoItems": []
}
],
"isHazmat": true,
"isReefer": true,
"isLithium": true,
"isRestricted": true,
"isStackable": "N",
"isForkliftable": "N",
"isTiltable": "N"
},
"shipmentPartyDetail": [
{
"type": "SHPR",
"accountNumber": "999999999",
"contactDetail": {
"name": "Zeus",
"emailAddress": "test1@ups.com",
"faxNumber": "",
"phoneNumber": "+1-8888888888",
"referenceNumber": ""
},
"address": {
"companyName1": "Walmart",
"companyName2": "",
"addressLine1": "702 SW 8th St",
"addressLine2": "Bentonville",
"addressLine3": "",
"city": "LOS ANGELES",
"stateCode": "CA",
"postalCode": "90001",
"countryCode": "US",
"isLoadingDockAvailable": "N",
"isResidentialAddress": "N"
}
},
{
"type": "CONS",
"accountNumber": "999999998",
"contactDetail": {
"name": "Sheldon",
"emailAddress": "test2@ups.com",
"faxNumber": "",
"phoneNumber": "+1-8888888778",
"referenceNumber": ""
},
"address": {
"companyName1": "Medtronic",
"companyName2": "",
"addressLine1": "99 Hereford Street",
"addressLine2": "Brampton",
"addressLine3": "",
"city": "OTTAWA",
"stateCode": "ON",
"postalCode": "K1A0H5",
"countryCode": "CA",
"isLoadingDockAvailable": "N",
"isResidentialAddress": "N"
}
},
{
"type": "THRD",
"accountNumber": "708832704",
"contactDetail": {
"name": "Zeus",
"emailAddress": "test3@ups.com",
"faxNumber": "",
"phoneNumber": "",
"referenceNumber": ""
},
"address": {
"companyName1": "Walmart",
"companyName2": "",
"addressLine1": "702 SW 8th St",
"addressLine2": "Bentonville",
"addressLine3": "",
"city": "LOS ANGELES",
"stateCode": "CA",
"postalCode": "90001",
"countryCode": "US",
"isLoadingDockAvailable": "N",
"isResidentialAddress": "N"
}
}
]
}{
"response": {
"quoteSummary": {
"quoteId": "AEA10002864",
"status": "ShipmentPending",
"serviceType": "DF",
"transitTime": 3,
"serviceLine": "Air",
"serviceGroup": "NAAF",
"confirmationId": "326250024",
"createDate": "2025-11-22T15:48:54.8774961Z",
"netTotal": 0,
"validTill": "0001-01-01T00:00:00Z",
"originPort": {
"code": "",
"name": ""
},
"destinationPort": {
"code": "",
"name": ""
},
"nonConformalReasons": [],
"pricingDetail": {
"rateType": "Market",
"message": "",
"currencyCode": "USD",
"actualTotalPrice": 290.26,
"netTotalPrice": 290.26,
"discountDetail": {
"discount": 0,
"discountPercent": 0,
"discountValidTill": "2025-12-31T00:00:00Z"
}
},
"estimateChargableWeight": 7,
"estimateChargableWeightUnit": "lb",
"chargeDetails": [
{
"shipmentPartyType": "SHPR",
"charges": [
{
"chargeType": "AF",
"chargeAmount": 176.07,
"currency": "USD"
},
{
"chargeType": "35",
"chargeAmount": 50,
"currency": "USD"
},
{
"chargeType": "33",
"chargeAmount": 43.19,
"currency": "USD"
},
{
"chargeType": "83",
"chargeAmount": 15,
"currency": "USD"
},
{
"chargeType": "MINADJ",
"chargeAmount": 6,
"currency": "USD"
}
]
},
{
"shipmentPartyType": "CONS",
"charges": []
},
{
"shipmentPartyType": "THRD",
"charges": [
{
"chargeType": "961",
"chargeAmount": 0,
"currency": "USD"
}
]
}
]
}
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Invalid request"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
request_type* | Air |
quote_id* | AEA10004706 |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"quoteSummary": {
"quoteId": "AEA10004706",
"status": "ShipmentPending",
"confirmationId": "328250356",
"shipmentNumber": "3460137351",
"serviceType": "DF",
"transitTime": 3,
"serviceLine": "Air",
"serviceGroup": "NAAF",
"movementTypeCode": "DTD",
"incoTermType": "EXW",
"createDate": "2025-11-24T07:24:41.1456919",
"netTotal": 0,
"validTill": "0001-01-01T00:00:00",
"validity": 0,
"originPort": {
"portCode": "",
"portName": "",
"serviceType": "",
"serviceCenterCode": "",
"serviceRatedOverCode": ""
},
"destinationPort": {
"portCode": "",
"portName": "",
"serviceType": "",
"serviceCenterCode": "",
"serviceRatedOverCode": ""
},
"portOfLoad": "",
"portOfDischarge": "",
"pricingDetail": {
"rateType": "Market",
"rateDescription": "Applied Market Rates For PA, as published rates (GCNAAF) were resolved for 'AF' charge",
"currencyCode": "USD",
"actualTotalPrice": 535.26,
"netTotalPrice": 535.26,
"discountDetail": {
"discount": 0,
"discountPercent": 0,
"eligibleDiscount": 0,
"eligibleDiscountPercent": 0,
"discountAdjustedFor": "",
"discountValidTill": ""
}
},
"estimateChargableWeight": 7,
"estimateChargableWeightUnit": "lb",
"chargeDetails": [
{
"shipmentPartyType": "SHPR",
"charges": []
},
{
"shipmentPartyType": "CONS",
"charges": []
},
{
"shipmentPartyType": "THRD",
"charges": [
{
"chargeType": "961",
"description": "NON-CONFORMING CARGO",
"chargeAmount": 245,
"currency": "USD",
"originalChargeAmount": ""
},
{
"chargeType": "AF",
"description": "AIR FREIGHT",
"chargeAmount": 176.07,
"currency": "USD",
"originalChargeAmount": ""
},
{
"chargeType": "35",
"description": "CANADIAN IMPORT TERMINATION FEE",
"chargeAmount": 50,
"currency": "USD",
"originalChargeAmount": ""
},
{
"chargeType": "33",
"description": "FUEL-INDEX",
"chargeAmount": 43.19,
"currency": "USD",
"originalChargeAmount": ""
},
{
"chargeType": "83",
"description": "US EXPORT COMPLIANCE FEE",
"chargeAmount": 15,
"currency": "USD",
"originalChargeAmount": ""
},
{
"chargeType": "MINADJ",
"description": "MINIMUM INVOICE ADJUSTMENT",
"chargeAmount": 6,
"currency": "USD",
"originalChargeAmount": ""
}
]
}
],
"paymentTerm": {
"type": "THRD",
"code": "OTH/CON"
},
"shipmentPartyDetail": [
{
"type": "THRD",
"accountNumber": "708832704",
"contactDetail": {
"name": "Zeus",
"emailAddress": "pkunja@ups.com",
"faxNumber": "",
"phoneNumber": "",
"referenceNumber": ""
},
"address": {
"companyName1": "Walmart",
"companyName2": "",
"addressLine1": "7500 CENTURION PARKWAY",
"addressLine2": " ",
"addressLine3": "",
"city": "JACKSONVILLE",
"stateCode": "FL",
"postalCode": "32256",
"countryCode": "US",
"isLoadingDockAvailable": "",
"isResidentialAddress": ""
}
},
{
"type": "SHPR",
"accountNumber": "",
"contactDetail": {
"name": "Zeus",
"emailAddress": "pkunja@ups.com",
"faxNumber": "",
"phoneNumber": "+1-8888888888",
"referenceNumber": ""
},
"address": {
"companyName1": "Walmart",
"companyName2": "",
"addressLine1": "702 SW 8th St",
"addressLine2": "Bentonville",
"addressLine3": "",
"city": "LOS ANGELES",
"stateCode": "CA",
"postalCode": "90001",
"countryCode": "US",
"isLoadingDockAvailable": "",
"isResidentialAddress": ""
}
},
{
"type": "CONS",
"accountNumber": "",
"contactDetail": {
"name": "Sheldon",
"emailAddress": "pkunja@ups.com",
"faxNumber": "",
"phoneNumber": "+1-8888888778",
"referenceNumber": ""
},
"address": {
"companyName1": "Medtronic",
"companyName2": "",
"addressLine1": "99 Hereford Street",
"addressLine2": "Brampton",
"addressLine3": "",
"city": "OTTAWA",
"stateCode": "ON",
"postalCode": "K1A0H5",
"countryCode": "CA",
"isLoadingDockAvailable": "",
"isResidentialAddress": ""
}
}
],
"shipmentDetails": {
"insuredValuecurrency": "USD",
"insuredValue": 0,
"customsValuecurrency": "USD",
"customsValue": 0,
"commodityName": "Books",
"fclCargoItems": [],
"lclCargoItems": [],
"airCargoItems": [
{
"quantity": 1,
"weight": {
"weight": 5,
"unitOfMeasurement": "lb"
},
"dimensions": {
"length": 3,
"width": 8,
"height": 3,
"unitOfMeasurement": "in"
}
},
{
"quantity": 1,
"weight": {
"weight": 2,
"unitOfMeasurement": "lb"
},
"dimensions": {
"length": 1,
"width": 8,
"height": 4,
"unitOfMeasurement": "in"
}
}
],
"location": [
{
"portCode": "",
"portName": "",
"serviceType": "Origin",
"serviceCenterCode": "LAX",
"serviceRatedOverCode": "LAX"
},
{
"portCode": "",
"portName": "",
"serviceType": "Destination",
"serviceCenterCode": "YOW",
"serviceRatedOverCode": "YOW"
}
]
}
}
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Invalid request"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}PATCH
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"quoteId": "AEA10004658",
"specialInstructions": "hello",
"pickupDetails": {
"date": "2025-11-25",
"startTime": "10:12",
"endTime": "12:22"
},
"requestType": "Air"
}{
"response": {
"quoteBookSummary": {
"quoteId": "AEA10004707",
"status": "ShipmentInitiated",
"shipmentNumber": "3460137373",
"confirmationId": "328250372",
"bookingReference": "",
"createDate": "2025-11-24T07:26:58.4170418",
"cargoDetails": {
"isStackable": "Y",
"isForkliftable": "N",
"isTiltable": "Y"
}
}
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Invalid request"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}GET
| Query Parameter Name | Example |
|---|---|
business_id* | COSTCO |
ups_file_number | 158599901829110 |
ups_office | 2106 |
ups_shipment_number* | 5358629782 |
| Header Name | Example |
|---|---|
transId | "N29245123456789" |
transactionSrc* | "GlobalAdvisor" |
Content-Type* | "application/json" |
X-BusinessGUID* | "12345678-34CD-1233-A678-B00000000000" |
X-ClientId* | "12345678-12AB-1234-A789-00000000000A" |
{
"response": {
"primaryInformation": {
"id": "5358629782.primary-information",
"shipmentNumber": "5358629782",
"upsFileNumber": "158599901829110",
"upsOffice": "2106",
"upsDatasource": "E2KEX",
"shipper": "SAMSUNG SDS GSCL CANADA LTD",
"destinationConsignee": "COSTCO DEPOT VARENNES 573 574 946",
"principal": "SAMSUNG SDSGSCL CANADA LTD OUTBOUND",
"proofOfDelivery": "John Smith",
"podDateTime": "2025-01-10T14:30:00Z",
"shipmentType": "Air",
"shipmentServiceLevel": "UPS 3 Day Air Freight Non Guaranteed",
"modeOfTransportCode": "A",
"modeOfTransportName": "Air",
"primaryException": "",
"shipmentBookedDateTime": "2025-01-01T10:00:00Z",
"shipmentCreateDateTime": "2025-01-01T09:00:00Z",
"originalScheduledDeliveryDateTime": "2025-01-10T12:00:00Z",
"latestScheduledDeliveryDateTime": "2025-01-10T12:00:00Z",
"product": "UPS Air Freight",
"actualDeliveryDateTime": "2025-01-10T14:30:00Z",
"milestoneStatus": "Delivered",
"shipmentLatestStatusDateTime": "2025-01-10T14:30:00Z",
"lastKnownLocation": "Atlanta, GA",
"consigneeReferenceNumber": [
{
"referenceType": "CONS_REF",
"referenceNumber": "CONS123"
}
],
"customerPONumber": [
{
"referenceType": "PO",
"referenceNumber": "PO987654"
}
],
"references": [
{
"code": "REF001",
"type": "Customer Reference",
"number": "CUST123456",
"createdDate": "2025-01-01T09:00:00Z"
}
],
"shipmentAdditionalInformation": {
"shipmentCategory": "General Cargo",
"quantity": "10",
"itemDescription": "Electronic Equipment",
"incoterms": "DAP",
"freightPaymentTerm": "Prepaid",
"actualWeight": {
"weight": "500",
"uomCode": "KG",
"uomLabel": "Kilograms"
},
"chargeableWeight": {
"weight": "550",
"uomCode": "KG",
"uomLabel": "Kilograms"
},
"shipmentVolume": {
"volume": "2.5",
"uomCode": "CBM",
"uomLabel": "Cubic Meters"
}
},
"shipmentOrigin": {
"addressLine1": "123 Industrial Blvd",
"addressLine2": "Suite 100",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "US",
"unloc": "USLAX"
},
"shipmentDestination": {
"addressLine1": "456 Commerce St",
"addressLine2": "Building A",
"city": "Atlanta",
"stateProvince": "GA",
"postalCode": "30303",
"country": "US",
"unloc": "USATL"
},
"flightVoyageInformation": [
{
"leg": "1",
"displayDepartureLocation": "Los Angeles (LAX)",
"displayArrivalLocation": "Atlanta (ATL)",
"carrierCode": "UA",
"carrierName": "United Airlines",
"vessel": "Boeing 777",
"flightVoyageNumber": "UA1234",
"estimateDepartureDateTime": "2025-01-02T08:00:00Z",
"confirmedDepartureDateTime": "2025-01-02T08:15:00Z",
"estimatedArrivalDateTime": "2025-01-02T16:00:00Z",
"confirmedArrivalDateTime": "2025-01-02T15:45:00Z",
"masterBill": "MASTER123456"
}
],
"milestones": {
"shipmentMilestones": [
{
"id": "M001",
"label": "Picked Up",
"milestoneCompletionDateTime": "2025-01-01T14:00:00Z",
"milestoneUNLOC": "USLAX"
},
{
"id": "M002",
"label": "In Transit",
"milestoneCompletionDateTime": "2025-01-02T08:15:00Z",
"milestoneUNLOC": "USLAX"
},
{
"id": "M003",
"label": "Delivered",
"milestoneCompletionDateTime": "2025-01-10T14:30:00Z",
"milestoneUNLOC": "USATL"
}
]
},
"shipmentExceptionDetails": {
"exceptionCount": "0",
"exceptionList": []
},
"containerInformation": [
{
"containerNumber": "CONT123456",
"containerType": "Pallet",
"containerDescription": "Standard Air Pallet",
"seal": "SEAL789",
"quantity": "10",
"containerWeight": {
"weight": "500",
"uomCode": "KG",
"uomLabel": "Kilograms"
},
"containerVolume": {
"volume": "2.5",
"uomCode": "CBM",
"uomLabel": "Cubic Meters"
}
}
],
"contactInfo": [
{
"role": "SHPR",
"roleName": "Shipper",
"account": "123456",
"businessId": "BUS123456",
"name": "ABC Company",
"phone": "+1-555-1234",
"attention": "Shipping Department",
"address": {
"street": "123 Industrial Blvd",
"city": "Los Angeles",
"stateProvince": "CA",
"postalCode": "90001",
"country": "US",
"unloc": "USLAX"
}
}
]
}
}
}{
"response": {
"errors": [
{
"code": "-1001",
"message": "Required field is missing"
}
]
}
}{
"response": {
"errors": [
{
"code": "-250002",
"message": "Invalid Authentication Information."
}
]
}
}{
"response": {
"errors": [
{
"code": "9999",
"message": "The requested shipment was not found."
}
]
}
}{
"response": {
"errors": [
{
"code": "-1003",
"message": "Internal Server Error"
}
]
}
}Service Homepage: github.com/UPS-API/api-documentation/blob/main/Forwarding.yaml
upslogisticsfreightshippingtransportationrest