Skip to main content
Version: v1

Reseller Documentation

Welcome to the Reseller API. This is the partner-facing surface of the platform: it lets resellers browse the catalog, place orders on behalf of their own customers and receive delivery callbacks once those orders are fulfilled.

Authentication​

The Reseller API uses JWT bearer tokens issued by the Generate Token endpoint with the credentials assigned to your reseller account. Send the token on every authenticated request:

Authorization: Bearer <your_jwt_token>

Note: Reseller credentials are issued by the platform owner. Treat them as production secrets — store them in a secret manager and never embed them in client-side code.

Typical integration flow​

  1. Authenticate — call Generate Token with your reseller credentials to obtain a JWT.
  2. Browse the catalog — use List Product Categories, List Product Category Types, List Products and Get Product Detail to discover what you can sell.
  3. Place an order — call Create Order with the product reference, quantity and the unique order identifier you generate on your side.
  4. Track the order — use List Orders and Get Order Detail to follow the order's lifecycle.
  5. Receive a delivery callback — once an order is fulfilled, the platform POSTs to your configured callback URL. See Order Delivery Webhook for the exact payload.
  6. Cancel if needed — use Cancel Order before delivery to abort an order.
  7. Reconcile your balance — call Account Details to check the reseller balance and limits.

Callbacks​

The platform can push two kinds of callbacks to URLs you control:

  • Order Delivery Callback — fires when an order is delivered. Payload mirrors Order Delivery Webhook.
  • Product Update Callback — fires when product attributes (price, stock, status) change. Payload mirrors Product Update Webhook.

Contact the platform owner to register the callback URLs for your reseller account.

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 your account currency.
  • Errors follow the platform's standard error envelope — branch on errorCode, never on the human-readable message.

Best practices​

  • Idempotency — always pass your own unique order identifier when creating an order so retries can be de-duplicated server-side.
  • Polling vs. callbacks — callbacks deliver updates in near real-time; periodic polling of List Orders / Get Order Detail is a safety net for missed callbacks.
  • Refresh tokens before they expire to avoid interrupting order flow.
  • Validate prices and stock with Get Product Detail immediately before placing high-value orders.

If you have questions about onboarding, callback configuration or production credentials, please reach out to the platform owner.

Authentication​

Token only! Please use without Bearer tag/prefix.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT