API documentation

Profile

Method	Endpoint	Description
GET	/profile	Read your own store profile
PUT	/profile	Update your business details and location
POST	/profile/logo	Replace your store logo (multipart)
POST	/profile/cover	Replace your store cover (multipart)

Categories

Method	Endpoint	Description
GET	/categories	List categories with nested subcategories
GET	/categories/{slug}	Show a category's subcategories

Products

Method	Endpoint	Description
GET	/products	List your products (paginated)
GET	/products/{sku}	Show one product with its variants
POST	/products	Create a product (multipart)
PUT	/products/{sku}	Update a product
DELETE	/products/{sku}	Delete a product
PATCH	/products/{sku}/stock	Update price and/or quantity
POST	/products/bulk	Bulk create or update up to 100 products
POST	/products/stock-updates	Set new prices and quantities for up to 500 products or variants, and switch products on or off
POST	/products/bulk-delete	Delete up to 500 products by SKU

Product Variants

Method	Endpoint	Description
POST	/products/variants/generate	Preview attribute combinations
PUT	/products/{sku}/variants	Create or update variants (multipart)
GET	/products/{sku}/variants	List a product's variants
GET	/products/{sku}/variants/{variant}	Show one variant
DELETE	/products/{sku}/variants/{variant}	Delete a variant

Product Add-ons

Method	Endpoint	Description
GET	/products/{sku}/addons	List a product's add-ons
GET	/products/{sku}/addons/{addon}	Show one add-on
POST	/products/{sku}/addons	Create an add-on
PUT	/products/{sku}/addons/{addon}	Update an add-on
DELETE	/products/{sku}/addons/{addon}	Delete an add-on (blocked if it has orders)

Attributes

Method	Endpoint	Description
GET	/attributes	List your attributes
GET	/attributes/{id}	Show one attribute
POST	/attributes	Create an attribute
PUT	/attributes/{id}	Update an attribute
DELETE	/attributes/{id}	Delete an attribute

Discounts

Method	Endpoint	Description
GET	/discounts	List your product discounts
GET	/discounts/{discount}	Show one discount
POST	/discounts	Create a discount (multipart)
PUT	/discounts/{discount}	Update a discount
DELETE	/discounts/{discount}	Delete a discount

Orders

Method	Endpoint	Description
GET	/orders	List your orders (paginated, filterable)
GET	/orders/rejection-reasons	List valid rejection reasons
GET	/orders/{id}	Show one order in full detail
PUT	/orders/{id}	Transition an order status
POST	/orders/{id}/handoff	Hand an order off to delivery
POST	/orders/{id}/handoff/reset	Retired: a handoff cannot be undone (always 400)
POST	/orders/{id}/request-cancellation	Request delivery cancellation

Abandoned carts

Method	Endpoint	Description
GET	/abandoned-carts	List abandoned carts grouped by customer
GET	/abandoned-carts/{customer}	Show one customer's abandoned cart lines

Reviews

Method	Endpoint	Description
GET	/reviews	List reviews of your products and store
GET	/reviews/{review}	Show one review

Notifications

Method	Endpoint	Description
GET	/notifications	List your notification feed
GET	/notifications/unread-count	Count unread notifications
POST	/notifications/read-all	Mark all notifications read
POST	/notifications/read	Mark several notifications read
DELETE	/notifications	Delete several notifications
POST	/notifications/{notification}/read	Mark one notification read
DELETE	/notifications/{notification}	Delete a notification

Collections

Method	Endpoint	Description
GET	/collections	List your product collections
GET	/collections/{collection}	Show one collection with its products
POST	/collections	Create a collection (multipart)
PUT	/collections/{collection}	Update a collection
DELETE	/collections/{collection}	Delete a collection

Influencers

Method	Endpoint	Description
GET	/influencers	List your influencers
GET	/influencers/{influencer}	Show one influencer
POST	/influencers	Create an influencer
PUT	/influencers/{influencer}	Update an influencer
DELETE	/influencers/{influencer}	Delete an influencer (blocked if it has orders)

Branches

Method	Endpoint	Description
GET	/branches	List your store branches
GET	/branches/{branch}	Show one branch
POST	/branches	Create a branch
PUT	/branches/{branch}	Update a branch
DELETE	/branches/{branch}	Delete a branch

Operators

Method	Endpoint	Description
GET	/operators	List your operators (staff sub-accounts)
GET	/operators/{operator}	Show one operator
POST	/operators	Create an operator
PUT	/operators/{operator}	Update an operator
DELETE	/operators/{operator}	Delete an operator

Settlements

Method	Endpoint	Description
GET	/settlements	List your settlement batches (filter by rail/date)
GET	/settlements/stats	Aggregate stats for a filtered set
GET	/settlements/{settlement}	Show one settlement
POST	/settlements/{settlement}/export	Queue a transactions export
POST	/settlements/export	Queue a filtered transactions export

Debts

Method	Endpoint	Description
GET	/debts	List your debts
GET	/debts/stats	Aggregate debt wallet stats
GET	/debts/{debt}	Show one debt

Transactions

Method	Endpoint	Description
GET	/transactions	List your transaction ledger

Opening hours

Method	Endpoint	Description
GET	/opening-hours	Read the weekly opening hours (per store)
PUT	/opening-hours	Set the weekly opening hours (per store)

Ordering schedule

Method	Endpoint	Description
GET	/ordering-schedule	Read the weekly ordering schedule (per store)
PUT	/ordering-schedule	Set the weekly ordering schedule (per store)

Delivery settings

Method	Endpoint	Description
GET	/delivery-settings	Read fulfilment toggles and shipment charges
PUT	/delivery-settings	Set fulfilment toggles and self-delivery charges

Dashboard stats

Method	Endpoint	Description
GET	/dashboard-stats	Headline figures: wallet, order mix, payouts, abandoned carts

Exports

Method	Endpoint	Description
POST	/exports/orders	Queue an orders export
POST	/exports/products	Queue a products export
POST	/exports/abandoned-carts	Queue an abandoned-carts export
POST	/exports/wholesale-orders	Queue a wholesale orders export
POST	/exports/stock-template	Queue the stock template to fill in and send back
GET	/exports/{id}	Poll an export and get the download link

Webhooks

Method	Endpoint	Description
GET	/webhook	Get your webhook config
PUT	/webhook	Create or replace your webhook config
DELETE	/webhook	Delete your webhook config
POST	/webhook/test	Send a synthetic test event

Wholesale — Catalog

Method	Endpoint	Description
GET	/catalog/sellers	List wholesale seller merchants (excludes the caller), with the wholesale category tree attached
GET	/catalog	List wholesale-enabled products, filterable by search, category, subcategory and seller
GET	/catalog/{id}	Show one wholesale product in full, including variants and their attribute values

Wholesale — Cart

Method	Endpoint	Description
GET	/cart	View the wholesale cart with per-line prices and the grand total
POST	/cart	Add a product or a specific variant to the wholesale cart
PUT	/cart/{cartItem}	Update a cart line's quantity (set, increment, or decrement)
DELETE	/cart/{cartItem}	Remove a single line from the wholesale cart
DELETE	/cart	Clear every line from the wholesale cart in one call

Wholesale — Buyer orders

Method	Endpoint	Description
GET	/orders/buyer	List your wholesale purchases, filterable by status including pending_receipt
POST	/orders/buyer	Place a wholesale order built from your current wholesale cart (no body)
GET	/orders/buyer/{id}	Show one of your wholesale orders in full detail, with items and seller
POST	/orders/buyer/{id}/confirm-received	Confirm a delivered order was physically received
POST	/orders/buyer/{id}/cancel	Cancel a pending or accepted order; accepted cancellations restore stock

Wholesale — Seller orders

Method	Endpoint	Description
GET	/orders/seller	List wholesale orders where you are the seller, optionally filtered by status
GET	/orders/seller/{id}	Show one of your wholesale sales in full detail, including line items
POST	/orders/seller/{id}/accept	Accept a pending order; decrements stock and notifies the buyer
POST	/orders/seller/{id}/deliver	Mark an accepted order as delivered and notify the buyer
POST	/orders/seller/{id}/cancel	Cancel a pending order from the seller side and notify the buyer