Postman and OpenAPI

Postman

A ready-made collection has every endpoint plus the error cases worth knowing: an expired token, a wrong secret, a missing token and someone else's order.

Download both files in one zip, XSelly_Open_Platform.postman.zip, or one at a time:

File	What it is
XSelly_Open_Platform.postman_collection.json	The requests.
XSelly_Open_Platform.postman_environment.json	The variables: your base URL, your credentials, and the ids the requests pass along.

1. Import the collection and the environment file into Postman.
2. Pick XSelly Open Platform as the environment at the top right, open its variables, and fill in base_url with your base URL, and client_id and client_secret with your app's credentials.
3. Send List products. The collection gets an access token for you whenever the stored one is missing or within a minute of expiring, and keeps it in the environment. Get access token is there for when you want to see the exchange itself.
4. To create an order, also set product_variant_id to a variant id in that app's store. It creates a real order, so use a store where you are happy to have one. The new order's id is saved to order_id, so Get order detail works straight afterwards.

OpenAPI

The whole API, webhooks included, is described in one OpenAPI document. It is the same file the API Reference is built from:

• xselly-open-platform.yaml
• xselly-open-platform.json

Load it into Insomnia, Bruno or Postman, or give it to a client generator. It is written in OpenAPI 3.2, which older tools may not read yet.