Jump to Content
Guides
Recipes
API Reference
v2021-01-01
v2022-03-03
API Reference
v2022-03-03
Guides
Recipes
API Reference
Getting Started
All
Pages
Start typing to search…
JUMP TO
Overview
Getting Started
Shared API
Actions
List action templates
get
Create action template
post
Delete action template
del
Update action template
patch
List actions
get
Create action
post
Delete action
del
Update action
patch
Update action status
patch
Sync action
patch
Sync actions
post
User
Get current user and company
get
Get remaining steps for current company's onboarding.
get
Update user
patch
Roll API key
post
Document
List documents
get
Get document
del
Get Document
get
Upload image
post
Invoice
List invoices
get
Get invoice by ID
get
Partner
List partners
get
Create partner
post
Delete partner
del
Get partner
get
Update partner
patch
Reinvite partner
post
Get partner by companyId
get
Company
Create SFTP credentials
post
Delete SFTP credentials
del
Update SFTP credentials
patch
Shipping Methods
List shipping methods
get
Create makes a new shipping method for the current company.
post
Deletes the shipping method with the given ID.
del
Updates the shipping method with the given ID.
patch
Webhook
List webhook configurations
get
Create webhook configuration
post
Get webhook configuration
get
Update webhook configuration
patch
List webhook topics
get
Buyer API
Order
List orders
get
Create order
post
Get order
get
Update order
patch
Cancel order
post
Cancel order item
post
Create return
post
List returns
get
Get return
get
Price List
Get price list
get
Price List Entry
List price list entries
get
Get price list entry by variant ID
get
Product
List products
get
Get product
get
Update product
patch
Delete product image
del
Sync seller merchandising data to product. This will also force sync the product to the buyer if the integration supports it.
post
Get product validation errors
get
Get all product validation rulesets
get
Get product validation ruleset
get
Variant
List variants
get
Get variant
get
Update variant
patch
Seller API
Order
List orders
get
Get order
get
Update order
patch
Cancel order
post
Create fulfillment
post
Create invoice
post
Cancel order item
post
List returns
get
Get return
get
Accepts a return
patch
Completes a return
patch
Rejects a return
patch
Price List
List price lists
get
Create price list
post
Delete price list
del
Get price list
get
Update price list
patch
Add all variants to price list
post
Export price list CSV
get
Import price list CSV
post
Export price list CSV asynchronously
get
Preview price list CSV
post
Price List Entry
List price list entries
get
Create price list entry
post
Delete price list entry
del
Update price list entry
patch
Product
List products
get
Create product
post
Delete product
del
Get product
get
Update product
patch
Deselect product
put
Delete image
del
Select product
put
Variant
Delete variant
del
Update variant
patch
Powered by
Getting Started
Ask AI
