ESC
Example searches: “itemId”, “ein”, “Validate Auth”, “Add a Category”, “handle”
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Find out more about Foundation
Toggle dark mode
Admin APIs
Topics
Introduction
Servers
Authentication
Endpoints
Connection
Validate Auth
GET
Categories
Get Categories
GET
Add a Category
POST
Vendors
Get Vendors
GET
Add a Vendor
POST
Get Vendor By ID
GET
Update Vendor
PUT
Delete Vendor
DELETE
Brands
Get Brands
GET
Add a Brand
POST
Get Brand By ID
GET
Update Brand
PUT
Delete Brand
DELETE
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
Get Items
GET
Add an Item
POST
Get Item By ID
GET
Update Item
PUT
Delete Item
DELETE
Get Variants for an Item
GET
Add a Variant
POST
Get Variant By ID
GET
Update Variant
PUT
Delete Variant
DELETE
Buyers
Get Buyers
GET
Add a Buyer
POST
Get Buyer By ID
GET
Update Buyer
PUT
Delete Buyer
DELETE
Buyer Users
Get Buyer Users
GET
Add a Buyer User
POST
Get Buyer User By ID
GET
Update Buyer User
PUT
Delete Buyer User
DELETE
Reset Buyer User Password
POST
Resend Buyer User Invitation
POST
Deactivate Buyer User
PUT
Activate Buyer User
PUT
ItemImages
Get Item Images
GET
Add an Image to an Item
POST
Get Item Image By ID
GET
Update Item Image
PUT
Delete Item Image
DELETE
PriceLists
Get Price Lists
GET
Add a Price List
POST
Get Price List By ID
GET
Update Price List
PUT
Delete Price List
DELETE
Prices
Get Prices
GET
Add a Price
POST
Get Price By ID
GET
Update Price
PUT
Delete Price
DELETE
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Find out more about Foundation
Toggle dark mode
Admin APIs
Dismiss highlight
Show more
ItemImages