API reference
Every request goes to the address of the shop you connect to. In the examples that is
https://shop.example.com/api/v1.
OpenAPI file. Import it into Postman or your code generator to get all endpoints in one step.
Download openapi-v1.yamlConnection
| Method | Path | Purpose | Scope |
|---|---|---|---|
| GET | /ping | Test the connection | none |
Orders
| Method | Path | Purpose | Scope |
|---|---|---|---|
| POST | /orders | Create an order | orders.write |
| POST | /orders/validate | Check an order without creating it | orders.write |
| GET | /orders/{orderId} | Get an order | orders.read |
| PATCH | /orders/{orderId} | Update an order | orders.update |
| GET | /payment-methods | List payment methods | orders.write |
| GET | /referrers | List referrers | orders.write |
| GET | /order-statuses | List order statuses | orders.write |
Customers
| Method | Path | Purpose | Scope |
|---|---|---|---|
| GET | /customers/{externalId} | Get a customer | customers.read |
| GET | /customers/{externalId}/addresses | List a customer's addresses | customers.read |
| POST | /customers/{externalId}/addresses | Create an address | customers.write |
| PATCH | /customers/{externalId}/addresses/{addressId} | Change an address | customers.write |
| DELETE | /customers/{externalId}/addresses/{addressId} | Delete an address | customers.write |
| POST | /customers/{externalId}/notes | Create a note | customers.write |
| GET | /customer-labels | List customer labels | customers.read |
| PUT | /customers/{externalId}/labels | Set label values on a customer | customers.write |
| DELETE | /customers/{externalId}/labels/{valueId} | Remove a label value from a customer | customers.write |
| GET | /customer-classes | List customer classes | customers.read |
| PUT | /customers/{externalId}/class | Set a customer's class | customers.write |
Catalog
| Method | Path | Purpose | Scope |
|---|---|---|---|
| GET | /manufacturers | List manufacturers | manufacturers.read |
| POST | /manufacturers | Create a manufacturer | manufacturers.write |
| GET | /manufacturers/{id} | Get a manufacturer | manufacturers.read |
| PATCH | /manufacturers/{id} | Change a manufacturer | manufacturers.write |
| DELETE | /manufacturers/{id} | Delete a manufacturer | manufacturers.write |