Konnect Platform API Reference (1.0.0)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

The Konnect Platform APIs let custom marketplaces exchange order and inventory information with Konnect throughout the commerce lifecycle.

Use this reference to:

• Generate an access token for an onboarded marketplace integration.
• Receive inventory delta notifications through a marketplace-hosted webhook.
• Create orders with customer, shipment, item, payment, and pricing details.
• Retrieve the Konnect order and shipment identifiers created for a marketplace order.
• Assign courier and Air Waybill Number (AWB) details to self-ship shipments.
• Send shipment-status updates for forward, return, and RTO journeys.

Authentication

Call Generate Access Token with the credentials issued for your marketplace integration. Send the returned JWT in the x-access-token header on every other Konnect-hosted endpoint in this reference.

Integration directions

• Marketplace → Konnect: authentication, order creation, order retrieval, courier/AWB updates, and shipment-status updates.
• Konnect → Marketplace: inventory delta notifications sent to the webhook URL implemented and registered by the marketplace.

Validate marketplace-to-Konnect calls in UAT before sending production traffic.