View UPS Services

UPS Pickup Notification Preferences Virtual Sandbox

Manage and configure account-level pickup notification settings for UPS shipments.

The UPS Pickup Notification Preferences API allows developers to programmatically configure and retrieve notification settings at the account level. This service ensures that pickup-related alerts are correctly routed and managed according to user-defined preferences.

Use this hosted sandbox to simulate UPS Pickup Notification Preferences 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 pickup notification configuration payloads, test account-level preference retrieval, verify error handling for invalid account settings, and simulate successful updates to notification triggers before integrating with UPS production systems.

UPS Pickup Notification Preferences virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS Pickup Notification Preferences responses instantly.

https://ups-pickup-preferences.mock.beeceptor.com



Pickup Notification Preferences(2 operations)

Query Parameter NameExample
account_number*VMahRmkhBM
Header NameExample
UUID"4ce27ff5-8e17-4797-a8c1-089796dbed9c"
transId*"XOLTGateway-1742420314-1"
transactionSrc*"FCTC"
id_token"magna veniam"
Request Payload
Response Payload
{
  "statusMessage": "Number of items in payload: 0",
  "timeStamp": "2025-04-02T20:44:36.000Z",
  "payload": []
}
{
  "response": {
    "errors": [
      {
        "code": "PRF_GEN_006",
        "message": "uuid - Required field is missing"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "UJ0001",
        "message": "Invalid token or token is not present"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500",
        "message": "Internal Server Error"
      }
    ]
  }
}
Query Parameter NameExample
account_number*pBtJgKwR9v
Header NameExample
UUID"4ce27ff5-8e17-4797-a8c1-089796dbed9c"
transId*"XOLTGateway-1742420314-1"
transactionSrc*"FCTC"
id_token"in exercitation consectetur commodo Ut"
Request Payload
{
  "notificationIndicators": {
    "email": {
      "dayOfPickupInd": true,
      "dayBeforePickupInd": false,
      "preArrivalInd": false,
      "pickupUpdateInd": false,
      "pickupCompleteInd": true,
      "pickupCancellationInd": true,
      "enrollmentConfirmationInd": true,
      "smartPickupCutOffNotificationTimeInd": false,
      "smartPickupTriggerWarningInd": true,
      "smartPickupTriggerNotificationInd": true,
      "smartPickupTriggerCancellationInd": false,
      "pickupIncompleteNotificationInd": false,
      "pickupDelayedInd": true
    },
    "sms": {
      "dayOfPickupInd": true,
      "dayBeforePickupInd": false,
      "preArrivalInd": false,
      "pickupUpdateInd": false,
      "pickupCompleteInd": true,
      "pickupCancellationInd": true,
      "enrollmentConfirmationInd": true,
      "smartPickupCutOffNotificationTimeInd": false,
      "smartPickupTriggerWarningInd": true,
      "smartPickupTriggerNotificationInd": true,
      "smartPickupTriggerCancellationInd": false,
      "pickupIncompleteNotificationInd": false,
      "pickupDelayedInd": true
    }
  },
  "locale": "en_US",
  "emails": [
    "abc@example.com",
    "def@example.com"
  ]
}
Response Payload
{
  "statusMessage": "Number of items in payload: 1",
  "timeStamp": "2025-04-02T20:44:36.000Z",
  "payload": {
    "accountNumber": "123456",
    "versionNumber": 1740530158285357000,
    "notificationIndicators": {
      "email": {
        "dayOfPickupInd": true,
        "dayBeforePickupInd": false,
        "preArrivalInd": false,
        "pickupUpdateInd": false,
        "pickupCompleteInd": true,
        "pickupCancellationInd": true,
        "enrollmentConfirmationInd": true,
        "smartPickupCutOffNotificationTimeInd": false,
        "smartPickupTriggerWarningInd": true,
        "smartPickupTriggerNotificationInd": true,
        "smartPickupTriggerCancellationInd": false,
        "pickupIncompleteNotificationInd": false,
        "pickupDelayedInd": true
      },
      "sms": {
        "dayOfPickupInd": true,
        "dayBeforePickupInd": false,
        "preArrivalInd": false,
        "pickupUpdateInd": false,
        "pickupCompleteInd": true,
        "pickupCancellationInd": true,
        "enrollmentConfirmationInd": true,
        "smartPickupCutOffNotificationTimeInd": false,
        "smartPickupTriggerWarningInd": true,
        "smartPickupTriggerNotificationInd": true,
        "smartPickupTriggerCancellationInd": false,
        "pickupIncompleteNotificationInd": false,
        "pickupDelayedInd": true
      }
    },
    "locale": "en_US",
    "emails": [
      "abc@example.com",
      "def@example.com"
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "PRF_GEN_006",
        "message": "uuid - Required field is missing"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "UJ0001",
        "message": "Invalid token or token is not present"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500",
        "message": "Internal Server Error"
      }
    ]
  }
}
Service Homepage: github.com/UPS-API/api-documentation/blob/main/PickupNotificationPreferences.yaml
upslogisticsshippingnotificationspickup