Skip to main content
Version: v4

Supplier Documentation

Welcome to the Supplier API. This documentation describes the endpoints suppliers integrate with to fulfil orders placed on the platform.

Authentication​

Every request must include your API key in the HTTP header:

ApiKey: YOUR_API_KEY

API keys are issued by the platform owner. Keep them secret and rotate them if they are exposed.

Receiving orders​

You have two complementary ways to learn about new orders:

1. Polling​

Periodically call the List Awaiting Orders endpoint to retrieve the orders waiting to be fulfilled. This is the simplest integration model and works without any extra setup on your side.

2. Webhook notifications​

When a new order is created the platform can push a notification to a URL you control, so you do not need to poll. To enable this, contact the site owner and ask them to configure your order notification URL in your supplier integration settings. The platform will then POST order events to that URL as they happen — see Awaiting Order Notify Example for the exact payload.

Webhooks and polling can be used together: webhooks give you near-real-time delivery, and polling acts as a safety net for missed notifications.

Managing your catalog​

You can keep your product catalog in sync programmatically:

  • Use Add/Update Products to create new products or update existing ones (price, stock, attributes, etc.).
  • Use List Products to read back the current state.

Deliverable products​

The same catalog endpoints expose the products that you are authorised to deliver. Use them to confirm which SKUs you can fulfil before accepting an order.

Order lifecycle​

  1. Order is created on the platform → appears in List Awaiting Orders and (if configured) is pushed to your webhook.
  2. You acknowledge / process the order on your side.
  3. Use Deliver Order to mark the order as delivered once it has been shipped or handed over to the customer.
  4. The platform updates its internal state and notifies the merchant accordingly.

Conventions​

  • All endpoints accept and return JSON (Content-Type: application/json).
  • Timestamps are UTC, ISO-8601 (yyyy-MM-ddTHH:mm:ssZ).
  • Monetary amounts are decimal numbers in the order's currency.
  • Errors follow the platform's standard error envelope; check the HTTP status code first, then the message / errorCode fields in the body.

If you have any questions about onboarding, webhook setup or production credentials, please reach out to the platform owner.