UPS Export Assure Virtual Sandbox

Streamline cross-border trade with automated compliance guidance and prohibited goods checks.

The Export Assure API provides businesses with tools to manage shipping compliance, including commodity description guidance, Power of Attorney requirements, UPS prohibited goods checks, and advanced commodity compliance guidance to prevent customs delays and fines.

Use this hosted sandbox to simulate UPS Export Assure 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 commodity compliance workflows, test prohibited goods logic, verify POA requirement triggers, and ensure correct handling of tariff code-based guidance responses before integrating with UPS production customs systems.

UPS Export Assure virtual sandbox is up and running!

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

`https://ups-export-assure.mock.beeceptor.com`

Export Assure

POST

/importexport/exportassure

Submit shipment details and receive guidance from UPS. This endpoint includes four separate operations which may be requested individually or simultaneously: - Basic Description Guidance (Free Feature) - Power of Attorney (POA) Requirements (Free Feature) - UPS Prohibited Goods Guidance (Fr

Header Name	Example
`accountNumber`	`"766554"`
`transactionSrc`*	`"sunt eu laborum Lorem labore"`
`Content-Type`*	`"esse aliquip cillum labore ad"`
`Accept`*	`"eiusmod adipisicing Lorem laboris non"`

Request Payload

{
  "transID": "c5d87df5-ac58-4ff7-9f96-103debe66496",
  "evaluateDescriptions": true,
  "evaluatePoaRequirements": false,
  "evaluateImportExportRequirements": false,
  "shipment": {
    "id": "47cb07b6-69f1-4ded-95ff-953fee2667de",
    "importCountryCode": "CA",
    "exportCountryCode": "US",
    "translationLocale": "EN",
    "transModes": "INT_AIR",
    "shipmentType": "GIFT",
    "shipmentDescription": "gifts",
    "grossWeight": 15,
    "grossWeightUnit": "KG",
    "shipmentItems": [
      {
        "commodityId": "47cb07b6-69f1-4ded-95ff-953fee2667de",
        "eccn": "EAR99",
        "hsCode": "6109.10.0004",
        "description": "t-shirts",
        "originCountryCode": "US",
        "amountValue": 1200,
        "currencyCode": "USD",
        "quantity": 5,
        "UOM": "Dozen"
      },
      {
        "commodityId": "47cb07b6-69f1-4ded-95ff-953fee2667de",
        "eccn": "EAR99",
        "hsCode": "6109.10.0042",
        "description": "t-shirts",
        "originCountryCode": "US",
        "amountValue": 2400,
        "currencyCode": "USD",
        "quantity": 10,
        "UOM": "Dozen"
      }
    ]
  }
}

Response Payload

{
  "transID": "28b210b9-e686-4617-8cf4-9973e3ed4087",
  "shipment": {
    "id": "a5de8df8-0ada-45d6-ae36-b7dbc4d6f127",
    "hasCommodityWarnings": true,
    "descriptionGuidance": {
      "isMatched": true,
      "message": "Men's and women's cotton sport shirts",
      "sourceListName": "global",
      "matchedKeyword": "Gift"
    },
    "poaCompliance": {
      "importerPoaRequiredFlag": true,
      "importerEvaluationCriteria": "Description",
      "importerPoaOnFileIndicator": "Yes",
      "importerCommodityId": "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff",
      "importerCommodityDescription": "t-shirts",
      "exporterPoaRequiredFlag": true,
      "exporterEvaluationCriteria": "Description",
      "exporterPoaOnFileIndicator": "Yes",
      "exporterCommodityId": "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff",
      "exporterCommodityDescription": "t-shirts",
      "exporterOnlineFormFlag": true,
      "exporterDocuSignTemplateId": "c0375e04-0c6e-4e56-b01d-30b2f4b613bd"
    },
    "importExportCompliance": {
      "shipmentValue": 3600,
      "shipmentCurrencyCode": "USD",
      "translationLocale": "EN",
      "hasShipmentWarnings": true,
      "hasCommodityWarnings": true,
      "commodityWarningsMessage": "Your shipment may have compliance considerations; see below for additional detail",
      "isShipmentOverGiftValueThreshold": true,
      "shipmentOverGiftValueThresholdMessage": "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided",
      "isShipmentOverGiftWeightThreshold": false,
      "shipmentOverGiftWeightThresholdMessage": ""
    },
    "shipmentItems": [
      {
        "commodityId": "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff",
        "hsCode": "6109.10.0004",
        "description": "t-shirts"
      },
      {
        "commodityId": "6604a366-0371-4e4f-9bf8-5595b016365e",
        "hsCode": "6109.10.0042",
        "description": "t-shirts"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

{
  "transID": "WSCM003769601129231354517251D4CF",
  "shipment": {
    "id": "WSEXPID20231129135451752",
    "hasCommodityWarnings": true,
    "descriptionGuidance": {
      "isMatched": true,
      "message": "DVD Player Stereo",
      "sourceListName": "US origin",
      "matchedKeyword": "GOODS"
    },
    "poaCompliance": {
      "importerPoaRequiredFlag": true,
      "importerEvaluationCriteria": "Description",
      "importerPoaOnFileIndicator": "Yes",
      "importerCommodityId": "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff",
      "importerCommodityDescription": "t-shirts",
      "exporterPoaRequiredFlag": true,
      "exporterEvaluationCriteria": "Description",
      "exporterPoaOnFileIndicator": "Yes",
      "exporterCommodityId": "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff",
      "exporterCommodityDescription": "t-shirts",
      "exporterOnlineFormFlag": true,
      "exporterDocuSignTemplateId": "c0375e04-0c6e-4e56-b01d-30b2f4b613bd"
    },
    "importExportCompliance": {
      "shipmentValue": 2365,
      "shipmentCurrencyCode": "USD",
      "translationLocale": "EN",
      "hasShipmentWarnings": false,
      "hasCommodityWarnings": false,
      "commodityWarningsMessage": "sample message",
      "isShipmentOverGiftValueThreshold": false,
      "shipmentOverGiftValueThresholdMessage": "sample message",
      "isShipmentOverGiftWeightThreshold": false,
      "shipmentOverGiftWeightThresholdMessage": "sample message"
    },
    "shipmentItems": [
      {
        "commodityId": "1",
        "hsCode": "900150",
        "description": "DESCRIPTION",
        "descriptionGuidance": {
          "isMatched": true,
          "message": "provide a color and size",
          "sourceListName": "Global",
          "matchedKeyword": "DESCRIPTION"
        },
        "importExportCompliance": {
          "isUpsProhibited": false,
          "upsProhibitedMessage": "",
          "isTranslatedIndicator": false,
          "complianceOutput": [
            {
              "categoryType": "Export",
              "controlTypes": [
                {
                  "controlType": "Embargo/Sanction",
                  "controlTypeCode": "Embargo/Sanction",
                  "isRequired": "Yes",
                  "controlTypeMessage": "Embargo/Sanction required",
                  "controlDetails": [
                    {
                      "controlDetailName": "",
                      "controlDetailDescription": "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515."
                    }
                  ]
                },
                {
                  "controlType": "Document",
                  "controlTypeCode": "DOC",
                  "isRequired": "Maybe",
                  "controlTypeMessage": "Document maybe required",
                  "controlDetails": [
                    {
                      "controlDetailName": "DocuSignFormId",
                      "controlDetailDescription": "Trade Agreement between the United States and Canada (USMCA)"
                    }
                  ]
                },
                {
                  "controlType": "Miscellaneous Controls - Notification",
                  "controlTypeCode": "Miscellaneous Controls",
                  "isRequired": "Maybe",
                  "controlTypeMessage": "Miscellaneous Controls Maybe required",
                  "controlDetails": [
                    {
                      "controlDetailName": "DocuSignFormId",
                      "controlDetailDescription": "Trade Agreement between the United States and Canada (USMCA)"
                    }
                  ]
                },
                {
                  "controlType": "Free Trade Agreement",
                  "controlTypeCode": "FTA",
                  "isRequired": "Maybe",
                  "controlTypeMessage": "Free Trade Agreement Maybe Applicable",
                  "controlDetails": [
                    {
                      "controlDetailName": "",
                      "controlDetailDescription": "Caribbean Basin Economic Recovery Act"
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    ]
  },
  "response": {
    "errors": [
      {
        "code": "105.305",
        "description": "INVALID_FIELD_VALUE",
        "field": "shipment.shipmentItems[0].UOM",
        "message": "UOM is not valid",
        "value": "Liter",
        "type": "POA"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "EA_POA_04",
        "message": "Country code is not valid",
        "field": "evaluateImportExportRequirements",
        "value": "NB",
        "type": "POA"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "UJ0001",
        "message": "Invalid token or token is not present"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "404",
        "message": "The requested resource was not found"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

{
  "response": {
    "errors": [
      {
        "code": "405",
        "message": "The requested method is not allowed for this resource"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "response": {
    "errors": [
      {
        "code": "500",
        "message": "Internal server error"
      }
    ]
  },
  "perfStats": {
    "absLayerTime": "575",
    "fulfillTime": "Sun Mar 10 20:14:35.906 -04:00 2024",
    "receiptTime": "Sun Mar 10 20:14:35.331 -04:00 2024"
  }
}

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

upslogisticsshippingcompliancecustomstrade