UPS Interactive Description Guidance Virtual Sandbox

Guide international shippers through commodity classification to determine accurate HTS codes.

The Interactive Commodity Description API assists international shippers by providing a series of multiple-choice questions to improve commodity descriptions. This process helps map items to destination-specific Harmonized Tariff Schedule (HTS) codes, facilitating smoother customs clearance, reducing holds, and ensuring accurate assessment of duties and taxes.

Use this hosted sandbox to simulate UPS Interactive Description Guidance 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 the interactive question-and-answer workflow, verify the mapping of natural language descriptions to HTS codes, test session management for multi-step classification, and handle feedback submission flows for customs compliance logic.

UPS Interactive Description Guidance virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS Interactive Description Guidance responses instantly.

`https://ups-interactive-description.mock.beeceptor.com`

Interactive Description(3 operations)

POST

/interactive

Initiates an interactive description session for a product.

Header Name	Example
`transId`*	`"non cillum voluptate Exc"`
`transactionSrc`*	`"enim sed occaecat minim"`

Request Payload

{
  "commodityCountryOfOrigin": "DE",
  "commodityCurrencyCode": "MMK",
  "commodityDescription": "Running Shoes",
  "commodityHtsCode": "7323",
  "commodityQuantity": "1000",
  "commodityUnitOfMeasure": "l",
  "commodityValue": "50.50",
  "exportCountryCode": "IN",
  "importCountryCode": "US",
  "locale": "en_GB",
  "shipperAccountNumber": "OG2QKUB4R6",
  "shipperName": "Rath Inc"
}

Response Payload

{
  "actualHts": "701337",
  "confidence": 0.59,
  "newProductDescription": "Plastic water storage containers",
  "noMoreQuestions": false,
  "questions": [
    {
      "assumed": false,
      "id": "ddb79a4f-e294-43b3-a2fe-cd8e15c0d774",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "What is the capacity?",
      "selected": 1,
      "type": "multiple_choice"
    },
    {
      "assumed": false,
      "id": "3e36cad4-ea85-4972-8559-ebb4889162cb",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "Is it collapsible?",
      "selected": 4,
      "type": "multiple_choice"
    },
    {
      "assumed": false,
      "id": "cee3ce18-a6cf-448c-b304-7c49958bc62c",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "Is this item for food contact?",
      "selected": 4,
      "type": "multiple_choice"
    },
    {
      "assumed": false,
      "id": "b6036399-de32-4df1-82bb-dcbff81b40ae",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "What is the primary material?",
      "selected": 5,
      "type": "multiple_choice"
    },
    {
      "assumed": true,
      "id": "a1c54e8b-31e9-497f-aa8b-696ddf2eb6b3",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "What is the capacity?",
      "selected": 5,
      "type": "multiple_choice"
    }
  ],
  "session": {
    "historyDesc": [
      {
        "assumed": false,
        "id": "7ad1b74c-2ebb-4052-b44b-4a7d007d440b",
        "selected": 5
      },
      {
        "assumed": true,
        "id": "16de0537-5437-4411-b75d-2d74be65c67c",
        "selected": 4
      },
      {
        "assumed": true,
        "id": "a4c76fe8-120f-431d-a05a-3f94cf969cd3",
        "selected": 2
      }
    ],
    "id": "2def3de9-87c1-4c13-ab6c-3c0dba5d3d6f"
  },
  "suggestedHts": "73239300"
}

{
  "response": {
    "errors": [
      {
        "code": "4000",
        "message": "Invalid input provided"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "UJ0001",
        "message": "Invalid token or token is not present"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4015",
        "message": "Unsupported Media Type"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4022",
        "message": "Unprocessable Entity"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "5000",
        "message": "Internal Server Error"
      }
    ]
  }
}

POST

/interactive/{sessionId}

This endpoint facilitates the ongoing interactive process for refining a product description and determining its corresponding Harmonized Tariff Schedule (HTS) code. After initiating a session with the initial product description using the /interactive endpoint, users can continue their interacti

Header Name	Example
`transId`*	`"occaecat ut"`
`transactionSrc`*	`"dolor commodo"`

Request Payload

{
  "questions": [
    {
      "id": "e4c9a57a-6ad7-402a-91a8-278aa609c36e",
      "selected": 2
    },
    {
      "id": "e244112a-4da8-4455-9885-c4a3b42c78af",
      "selected": 3
    }
  ]
}

Response Payload

{
  "actualHts": "701337",
  "confidence": 0.8,
  "newProductDescription": "Plastic water storage containers",
  "noMoreQuestions": true,
  "questions": [
    {
      "assumed": false,
      "id": "554979c9-83e3-48e6-862f-d1f03df1c3aa",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "What is the capacity?",
      "selected": 2,
      "type": "multiple_choice"
    },
    {
      "assumed": false,
      "id": "7651159f-ae81-486d-8b42-de3ddccd7309",
      "options": [
        "For decorative purposes",
        "For storing or drinking water"
      ],
      "other": [
        "PET",
        "PPT"
      ],
      "question": "What is the primary material?",
      "selected": 1,
      "type": "multiple_choice"
    }
  ],
  "session": {
    "historyDesc": [
      {
        "assumed": false,
        "id": "0054c097-05cb-4be0-b1fd-4f3730e99bf4",
        "selected": 1
      },
      {
        "assumed": false,
        "id": "1650b9f2-95dc-46e3-8494-ee4c63f5b89b",
        "selected": 0
      }
    ],
    "id": "39fb75b5-6faf-48e9-9e8d-37c76516d243"
  },
  "suggestedHts": "73239300"
}

{
  "response": {
    "errors": [
      {
        "code": "4000",
        "message": "Invalid input provided"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "UJ0001",
        "message": "Invalid token or token is not present"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4015",
        "message": "Unsupported Media Type"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4022",
        "message": "Unprocessable Entity"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "5000",
        "message": "Internal Server Error"
      }
    ]
  }
}

POST

/interactive/feedback/{sessionId}

Allows the user to provide feedback on a specific question of the overall session.

Request Payload

{
  "feedback": "Too many steps",
  "id": "90cf8c87-92fe-46a7-98ee-0d8305fb70b4",
  "sentiment": true
}

Response Payload

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

{
  "response": {
    "errors": [
      {
        "code": "4000",
        "message": "Invalid input provided"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "UJ0001",
        "message": "Invalid token or token is not present"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4015",
        "message": "Unsupported Media Type"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4022",
        "message": "Unprocessable Entity"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "5000",
        "message": "Internal Server Error"
      }
    ]
  }
}

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

upslogisticsshippingcustomshtscompliance