UPS Delivery Intercept Virtual Sandbox

Manage shipment cancellations and rerouting requests for UPS packages.

The UPS Delivery Intercept API allows shippers to cancel or reroute shipments already in transit. It provides endpoints to check eligibility, request address changes, reschedule deliveries, or initiate returns, helping businesses automate post-shipment logistics and reduce manual customer service intervention.

Use this hosted sandbox to simulate UPS Delivery Intercept 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 endpoint to validate shipment intercept eligibility, test payload structures for rerouting or cancellation requests, and verify handling of transaction IDs and tracking number associations before integrating with UPS production logistics workflows.

UPS Delivery Intercept virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS Delivery Intercept responses instantly.

`https://ups-delivery-intercept.mock.beeceptor.com`

Delivery Intercept(7 operations)

POST

/charges/{tracking_number}

Obtains intercept charges specified by the inquiry type and tracking number passed in the interface.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

{
  "clientIP": "10.9.100.220",
  "ratingRequest": [
    {
      "redirectAddress": {
        "addressNickName": "John's work address",
        "addressInfo": {
          "addressLine1": "1899",
          "city": "Baltimore",
          "state": "MD",
          "postalCode": "21230-3410",
          "countryCode": "US",
          "buildingFloor": "2",
          "publicLocationId": "62200",
          "firstName": "Robert",
          "lastName": "Willams",
          "fullName": "Trk 7702 Paramus Ward",
          "phoneNumber": "+1987654324"
        },
        "nameOrCompanyName": "ACME Inc.",
        "contactName": "Robert",
        "phoneNumber": "+1987654324",
        "phoneExt": "+123",
        "emailAddress": "aups@ups.com"
      },
      "fromAddress": {
        "addressLine1": "1899",
        "city": "Baltimore",
        "state": "MD",
        "postalCode": "21230-3410",
        "countryCode": "US",
        "buildingFloor": "2",
        "publicLocationId": "62200",
        "firstName": "Robert",
        "lastName": "Willams",
        "fullName": "Trk 7702 Paramus Ward",
        "phoneNumber": "+1987654324"
      },
      "toAddress": {
        "addressLine1": "12911 FORK RD",
        "city": "BALDWIN",
        "state": "MD",
        "postalCode": "21013",
        "countryCode": "US",
        "buildingFloor": "2",
        "publicLocationId": "7002",
        "firstName": "Sam",
        "lastName": "carren",
        "fullName": "RICA80 CDW80",
        "phoneNumber": "+1987654324"
      },
      "trackInfo": {
        "interceptOption": "AL"
      }
    }
  ]
}

Response Payload

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "000",
    "statusMsg": "Success",
    "success": true,
    "addrToken": "2",
    "errors": null,
    "warnings": null,
    "chargeInfo": [
      {
        "trackingNumber": "1ZA2F8810719086435",
        "accessorialCharge": "0.00",
        "interceptCharge": "0.00",
        "transportationCharge": "0.00",
        "totalCharge": "0.00",
        "chargeCurrency": "USD",
        "estDeliveryDate": "20250220",
        "residentialIndicator": false,
        "additionalHandlingIndicator": false,
        "downgradeServiceCode": null,
        "oversizeCode": null,
        "serviceCode": "012",
        "serviceDesc": "UPS 3 Day Select",
        "packageWeight": "5",
        "packageWeightUOM": "LBS",
        "packagingType": "03",
        "interceptChargeDetail": [
          {
            "accessorialCharge": "21.00",
            "interceptCharge": "21.00",
            "transportationCharge": "0.00",
            "totalCharge": "21.00",
            "interceptOption": "AA",
            "displayShipperPaidInterceptCharges": false,
            "shipperPaidInterceptCharges": false,
            "successful": true,
            "currencyCode": "USD"
          },
          {
            "accessorialCharge": "21.00",
            "interceptCharge": "21.00",
            "transportationCharge": "0.00",
            "totalCharge": "21.00",
            "interceptOption": "FD",
            "displayShipperPaidInterceptCharges": false,
            "shipperPaidInterceptCharges": false,
            "successful": true,
            "currencyCode": "USD"
          },
          {
            "accessorialCharge": "21.00",
            "interceptCharge": "21.00",
            "transportationCharge": "0.00",
            "totalCharge": "21.00",
            "interceptOption": "RS",
            "displayShipperPaidInterceptCharges": false,
            "shipperPaidInterceptCharges": false,
            "successful": true,
            "currencyCode": "USD"
          }
        ],
        "shipperName": "ACME Inc.",
        "preTaxTotalCharge": "25.00",
        "taxDisclaimerIndicator": "NTA",
        "displayShipperPaidInterceptCharges": false,
        "shipperPaidInterceptCharges": false,
        "shipperPaidTransportationCharges": false,
        "displayShipperPaidTransportationCharges": false,
        "chargesPaidByThirdPartyShipper": false,
        "taxes": [
          {
            "tax": "City",
            "taxAmount": "5.00"
          },
          {
            "tax": "State",
            "taxAmount": "2.00"
          }
        ],
        "totalTax": "7.00"
      }
    ],
    "accessorialGrandTotal": "",
    "interceptGrandTotal": "",
    "transportationGrandTotal": "",
    "grandTotalCharge": "",
    "taxesGrandTotal": "",
    "preTaxGrandTotal": ""
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

GET

/eligibility/intercept/{tracking_number}

Retrieves the delivery change eligibility information for the tracking number passed in the interface.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

Response Payload

{
  "response": {
    "transactionId": "b2e514fc8a2",
    "statusCode": "000",
    "statusMsg": "SUCCESS",
    "success": true,
    "errors": null,
    "warnings": null,
    "commonEligibilityMap": [
      {
        "interceptFeature": "FD",
        "eligibilityValue": {
          "createEligibility": "ELIGIBLE",
          "modifyEligibility": "NOT_ELIGIBLE",
          "cancelEligibility": "NOT_ELIGIBLE",
          "dateOptionsforFutureDelivery": [
            {
              "date": 20250110,
              "dayOfWeekText": "Friday",
              "dayOfWeekNumber": 6
            },
            {
              "date": 20250115,
              "dayOfWeekText": "Wednesday",
              "dayOfWeekNumber": 4
            }
          ]
        }
      },
      {
        "interceptFeature": "WC",
        "eligibilityValue": {
          "createEligibility": "ELIGIBLE",
          "modifyEligibility": "NOT_ELIGIBLE",
          "cancelEligibility": "NOT_ELIGIBLE"
        }
      },
      {
        "interceptFeature": "SDWC",
        "eligibilityValue": {
          "createEligibility": "ELIGIBLE",
          "modifyEligibility": "NOT_ELIGIBLE",
          "cancelEligibility": "NOT_ELIGIBLE"
        }
      },
      {
        "interceptFeature": "RD",
        "eligibilityValue": {
          "createEligibility": "ELIGIBLE",
          "modifyEligibility": "NOT_ELIGIBLE",
          "cancelEligibility": "NOT_ELIGIBLE"
        }
      },
      {
        "interceptFeature": "RTS",
        "eligibilityValue": {
          "createEligibility": "ELIGIBLE",
          "modifyEligibility": "NOT_ELIGIBLE",
          "cancelEligibility": "NOT_ELIGIBLE",
          "reasonOptionsForRTS": [
            {
              "id": "AN",
              "value": "Duplicate Order"
            },
            {
              "id": "AS"
            }
          ]
        }
      }
    ]
  }
}

{
  "response": {
    "transactionId": "b2e514fc8a2",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

POST

/redirect/address/{tracking_number}

Submits a deliver to another address delivery change for the tracking number passed in the interface.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

{
  "requestType": "AA",
  "specialInstructions": "Handle With Care",
  "requesterContactInfo": {
    "name": "andreas",
    "telephone": "+12010000000",
    "phoneExt": "+123",
    "emailAddress": "aups@ups.com",
    "altTelephone": "+12345678",
    "altPhoneExt": "+1",
    "displayPhoneNumber": false
  },
  "newDeliveryAddress": {
    "addressNickName": "John's new address",
    "addressInfo": {
      "addressLine1": "12911 FORK RD",
      "addressLine2": "Washington",
      "addressLine3": "Washington",
      "city": "BALDWIN",
      "state": "MD",
      "postalCode": "21013",
      "countryCode": "US",
      "buildingFloor": "2",
      "publicLocationId": "800",
      "firstName": "sam",
      "lastName": "curren",
      "fullName": "sam curren",
      "phoneNumber": "+1988676185"
    },
    "nameOrCompanyName": "KRISTINA LEO",
    "contactName": "Andrea",
    "phoneNumber": "+2019909098",
    "phoneExt": "+2",
    "emailAddress": "aups@ups.com"
  }
}

Response Payload

{
  "transactionId": "ASR1212",
  "statusCode": "000",
  "statusMsg": "Success",
  "success": true,
  "errors": null,
  "subStatusCode": ""
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

POST

/willcall/{tracking_number}

Request your package to be held at or returned to a UPS facility where the receiver may claim the same-day.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

{
  "requestType": "WC",
  "specialInstructions": "Handle With Care",
  "requesterContactInfo": {
    "name": "John",
    "telephone": "+3522098238",
    "phoneExt": "+123",
    "emailAddress": "aups@ups.com",
    "altTelephone": "+3522098238",
    "altPhoneExt": "+3",
    "displayPhoneNumber": false
  }
}

Response Payload

{
  "transactionId": "ASR1212",
  "statusCode": "000",
  "statusMsg": "Success",
  "success": true,
  "errors": null,
  "subStatusCode": ""
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

POST

/return/{tracking_number}

Return a package to the original shipper prior to delivery.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

{
  "requestType": "RS",
  "specialInstructions": "Handle With Care",
  "requesterContactInfo": {
    "name": "andreas",
    "telephone": "+112010000000",
    "phoneExt": "+123",
    "emailAddress": "aups@ups.com",
    "altTelephone": "+19887654321",
    "altPhoneExt": "+12",
    "displayPhoneNumber": false
  },
  "reasonForReturn": "AM"
}

Response Payload

{
  "transactionId": "ASR1212",
  "statusCode": "000",
  "statusMsg": "Success",
  "success": true,
  "errors": null,
  "subStatusCode": ""
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

POST

/reschedule/{tracking_number}

Have the package delivered to the original address but on a different day in the future.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

{
  "requestType": "FD",
  "specialInstructions": null,
  "requesterContactInfo": {
    "name": "andreas",
    "telephone": "+112010000000",
    "phoneExt": "+1",
    "emailAddress": "aups@ups.com",
    "altTelephone": "+19887654321",
    "altPhoneExt": "+12",
    "displayPhoneNumber": false
  },
  "deliveryDate": "20240904"
}

Response Payload

{
  "transactionId": "ASR1212",
  "statusCode": "000",
  "statusMsg": "Success",
  "success": true,
  "errors": null,
  "subStatusCode": ""
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

POST

/cancel/{tracking_number}

Cancel a previously applied intercept on the package.

Query Parameter Name	Example
`loc`	`en_US`

Header Name	Example
`transId`*	`"0a1b9c2d8e3f43"`
`platformType`*	`"XOLT"`
`Content-Type`*	`"application/json"`
`inquiryType`*	`"U"`

Request Payload

{
  "requestType": "FD",
  "specialInstructions": null,
  "requesterContactInfo": {
    "name": "John A",
    "telephone": "+19881234567",
    "phoneExt": "+1",
    "emailAddress": "aups@ups.com",
    "altTelephone": "+19881234567",
    "altPhoneExt": "+12",
    "displayPhoneNumber": true
  }
}

Response Payload

{
  "transactionId": "ASR1212",
  "statusCode": "000",
  "statusMsg": "Success",
  "success": true,
  "errors": null,
  "subStatusCode": ""
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "400",
    "errors": [
      {
        "code": "710",
        "message": "Failure due to input validation error"
      }
    ]
  }
}

{
  "response": {
    "transactionId": "ASR1212",
    "statusCode": "401",
    "errors": [
      {
        "code": "605",
        "message": "Package address token does not match any tokens in the user's profile."
      }
    ]
  }
}

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

upslogisticsshippingdeliverytracking