View UPS Services

UPS TradeDirect Shipments Virtual Sandbox

Manage international and domestic trade shipments through the UPS TradeDirect system.

The TradeDirect Shipments API facilitates the management of external trade shipments within the TradeDirect system. It provides robust endpoints for creating, managing, and finalizing international and domestic shipments, including master, small package, and LTL shipments, as well as closing out master shipments.

Use this hosted sandbox to simulate UPS TradeDirect Shipments 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 shipment creation payloads, master shipment closeout workflows, child shipment deletion logic, and error handling for international trade operations before integrating with UPS production systems.

UPS TradeDirect Shipments virtual sandbox is up and running!

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

https://ups-tradedirect.mock.beeceptor.com



TradeDirect(5 operations)

Query Parameter NameExample
shipper_account_number*1234WW
Header NameExample
transId*"XZ345445668"
transactionSrc*"XOLT"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "response": {
    "errors": [
      {
        "code": "400001",
        "message": "Missing or Invalid parameter: {field name}"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "250002",
        "message": "Invalid Authentication Information."
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500000",
        "message": "We're sorry, the system is unavailable. Please try again later."
      }
    ]
  }
}
Header NameExample
transId*"XZ345445668"
transactionSrc*"XOLT"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "response": {
    "errors": [
      {
        "code": "400001",
        "message": "Missing or Invalid parameter: {field name}"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "250002",
        "message": "Invalid Authentication Information."
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500000",
        "message": "We're sorry, the system is unavailable. Please try again later."
      }
    ]
  }
}
Header NameExample
transId*"XZ345445668"
transactionSrc*"XOLT"
Request Payload
{
  "shipment": {
    "shipper": {
      "accountNumber": "1234WW"
    },
    "packages": [
      {
        "numberOfIdenticalUnits": 1,
        "handlingUnits": {
          "type": "BOXES",
          "dimensions": {
            "length": 48,
            "width": 40,
            "height": 36,
            "unitOfMeasurement": "IN"
          },
          "packageWeight": {
            "weight": 10,
            "unitOfMeasurement": "LBS"
          },
          "freightClass": 150,
          "transportationService": {
            "airService": 1,
            "groundService": 1
          }
        }
      }
    ]
  }
}
Response Payload
{
  "invoiceLabelResponse": {
    "files": [
      {
        "data": "base64encodedstring",
        "fileFormat": "PDF",
        "referenceId": "INV123456"
      }
    ]
  },
  "bolLabelResponse": {
    "files": [
      {
        "data": "baseencodedstring",
        "fileFormat": "PDF",
        "referenceId": "BOL123456"
      }
    ]
  },
  "palletLabelResponses": {
    "files": [
      {
        "opTyp": "PDF",
        "lblNmbr": "PLT123456",
        "lblData": "base64encodedstring"
      }
    ]
  }
}
{
  "message": "Movement has been closed successfully.",
  "invoiceLabelResponse": {
    "warning": "Use Document API to generate missing documents."
  },
  "bolLabelResponse": {
    "files": [
      {
        "data": "base64encodedstring",
        "fileFormat": "PDF",
        "referenceId": "BOL123456"
      }
    ]
  },
  "palletLabelResponses": {
    "files": [
      {
        "opTyp": "PDF",
        "lblNmbr": "PLT123456",
        "lblData": "base64encodedstring"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "400001",
        "message": "Missing or Invalid parameter: {field name}"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "250002",
        "message": "Invalid Authentication Information."
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500000",
        "message": "We're sorry, the system is unavailable. Please try again later."
      }
    ]
  }
}
Header NameExample
transId*"XZ345445668"
transactionSrc*"XOLT"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "response": {
    "errors": [
      {
        "code": "400001",
        "message": "Missing or Invalid parameter: {field name}"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "250002",
        "message": "Invalid Authentication Information."
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500000",
        "message": "We're sorry, the system is unavailable. Please try again later."
      }
    ]
  }
}
Header NameExample
transId*"XZ345445668"
transactionSrc*"XOLT"
Request Payload
{
  "requestedDoc": "BOL",
  "docFormat": "PDF",
  "usiNumber": "578299028T",
  "shipperAccountNumber": "1234WW"
}
Response Payload
{
  "documents": {
    "cci": "3MtNcTKd2VKWu0...br62U"
  }
}
{
  "response": {
    "errors": [
      {
        "code": "Application Error Code",
        "message": "Malformed JSON request"
      },
      {
        "code": "Application Error Code",
        "message": "Missing {Filed Name}"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "250002",
        "message": "Invalid Authentication Information."
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  }
}
{
  "response": {
    "errors": [
      {
        "code": "500000",
        "message": "We're sorry, the system is unavailable. Please try again later."
      }
    ]
  }
}
Service Homepage: github.com/UPS-API/api-documentation/blob/main/TradeDirect.yaml
upslogisticsshippingtradedirectsupply-chain