API overview
We currently have two API endpoints which serve different purposes.
First, we have an Order API endpoint, which allows interacting with order data and all its related datapoints such as fulfillment data and payment transaction data.
Second, we have an Product API endpoint, which allows interaction with product data and building a single source of truth. The Product API is currently in experimental state and will be realeased soon. In case you would like to test it, please reach out to us.
In case you are looking for our technical documentation, please refer to the API Reference.
Orders API
We currently support different interactions with our Orders API. In particular, we have threee main topics namely Orders, Payments and Fulfillments.
Orders
To interact with orders we support six different operation types as listed in the table below:
| HTTP Method | Description |
|---|---|
| GET | Fetch all orders |
| POST | Create an order |
| GET | Fetch a specific order |
| PATCH | Update a specific order |
| PATCH | Update the order status of a specific order |
| PATCH | Update the order status of multiple orders |
Payments
To interact with payments we support three different operation types as listed in the table below:
| HTTP Method | Description |
|---|---|
| GET | Fetch payment transactions of a specific order |
| POST | Add a payment transaction to a specific order |
| PATCH | Update a payment transaction |
Fulfillments
To interact with fulfillments we support four different operation types as listed in the table below:
| HTTP Method | Description |
|---|---|
| POST | Add a fulfillment to an order |
| GET | Fetch fulfillment of an order |
| PATCH | Update the fulfillment status of an order |
| PATCH | Update a fulfillment object |
Product API
Coming Soon