The Order APIs allow Integration Partners to create , validate and cancel orders. These endpoints are designed to support real-time order processing and updates within your integration.
Base URLs
UAT Base URL: <https://api.uat.khumbu.com/uat/v1>
Use the appropriate base URL for your environment or contact Khumbu Support for the same.
Create Order
- Endpoint:
{baseUrl}/providers/{integrationPartnerName}/partners/{posName}/markets/{marketName}/orders/notification - Method:
POST - Purpose: This endpoint is used to create a new order and send a notification to the POS system.
Request Parameters
- Headers:
Authorization:Bearer {access_token}
- Path Parameters:
{integrationPartnerName}: Replace with your assigned integration partner name (e.g.,standardprovider).{posName}: Replace with the specific POS system name for your integration (e.g.,simphony).{marketName}: Replace with an market identifier which is integration identifier of brand in a specific region. (e.g.,plkpl).
Fire Order
- Endpoint:
{baseUrl}/providers/{integrationPartnerName}/partners/{posName}/markets/{marketName}/order/fire - Method:
POST - Purpose: This endpoint is used to create a fire order and send a notification to the POS system.
Request Parameters
- Headers:
Authorization:Bearer {access_token}
- Path Parameters:
{integrationPartnerName}: Replace with your assigned integration partner name (e.g.,standardprovider).{posName}: Replace with the specific POS system name for your integration (e.g.,simphony).{marketName}: Replace with an market identifier which is integration identifier of brand in a specific region. (e.g.,plkpl).
Validate Cart
- Endpoint:
{baseUrl}/providers/{integrationPartnerName}/partners/{posName}/markets/{marketName}/orders/adjustcart - Method:
POST - Purpose: Verify the items or quantities in a cart.
Request Parameters
- Headers:
Authorization:Bearer {access_token}
- Path Parameters:
{integrationPartnerName}: Replace with your assigned integration partner name.(e.g.,standardprovider).{posName}: Replace with the specific POS system name for your integration. (e.g.,simphony).{marketName}: Replace with an market identifier which is integration identifier of brand in a specific region. (e.g.,plkpl).
Cancel Order
- Endpoint:
{baseUrl}/providers/{integrationPartnerName}/partners/{posName}/markets/{marketName}/orders/cancel - Method:
POST - Purpose: This endpoint is used to cancel an order and send a notification to the POS system.
Request Parameters
- Headers:
Authorization:Bearer {access_token}
- Path Parameters:
{integrationPartnerName}: Replace with your assigned integration partner name. (e.g.,standardprovider).{posName}: Replace with the specific POS system name for your integration. (e.g.,simphony).{marketName}: Replace with an market identifier which is integration identifier of brand in a specific region. (e.g.,plkpl).