Skip to main content
The pages under this section are generated from the API’s OpenAPI spec. Each one has the request shape, every response, every error the endpoint can return, and a Try it playground.

​
Base URL

This site has a version per environment (the switcher is in the top nav):
The Try it playground on each version’s pages is wired to that version’s own environment — the Production version calls production, the Staging (sandbox) version calls staging, and so on. Paste in a matching token: a wc_bot_test_… token from your sandbox install works on the Staging (sandbox) version, not on Production.

​
Authentication

POST /oauth/token and POST /oauth/revoke authenticate differently, with your App’s client_id / client_secret — see OAuth install.

​
Every response

Success:
Error:
Every response also carries an X-Request-Id header, matching request_id on an error.

Scopes

Error codes

Block types

Objects

Callbacks