API Reference

The TradingPartners AI API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Most of our endpoints require a bearer token for request authentication. The token must be provided in the Authorization header of the request.

You can use the TradingPartners AI API in test mode, which doesn't affect live data nor interact with the TradingPartners AI Core. The token you use to authenticate the request determines whether the request is a live mode or test mode.

You will find the test tokens on the dedicated page.

You can also retrieve a valid token using the Login API, only usable if you have an account. You can create an account using the Registration page.