API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Find out more about Foundation

Toggle dark mode

Topics

Introduction
Servers
Authentication

Endpoints

Connection
- Validate Auth GET
Categories
- Get Categories GET
- Add a Category POST
Vendors
Brands
Custom Fields
- Get a list of custom fields GET
- Add a Custom Field POST
Orders
- Get Orders GET
- Get Order By ID GET
REST Hooks
- Subscribe to a Hook Event POST
- Unsubscribe from a Hook Event DELETE
Items
Buyers
Buyer Users
ItemImages
PriceLists
Prices

Powered by Bump.sh

API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Find out more about Foundation

Toggle dark mode

Authentication

Api key auth (http_api_key)

Send an authentication token in the X-API-Key header to authenticate with the API.