Skip to main content

API Reference Overview

The eXlr8 Delivery Partner API provides comprehensive functionality for managing orders, products, and wallet operations.

Base URLs​

EnvironmentBase URL
UAT (Testing)https://stage-platform-exlr8.exlr8now.com
Productionhttps://prod-platform-exlr8.exlr8now.com

API Endpoints Summary​

No.API NameMethodEndpoint
1Select WalletPATCH/v1/delivery-partners/{dpID}/wallet/select
2Get Wallet BalanceGET/v1/delivery-partners/{dpID}/wallet/balance
3Get Wallet Transaction HistoryGET/v1/delivery-partners/{dpID}/wallet/transactions
4Get Available ProductsGET/v1/products/delivery-partners/{dpID}
5Get Product By IDGET/v1/products/delivery-partners/{dpID}/{productID}
6Place Voucher OrderPOST/v1/orders/b2b/direct-checkout
7Place Subscription OrderPOST/v1/orders/b2b/direct-checkout
8Get OrdersGET/v1/orders/b2b/delivery-partners/{dpID}
9Get Order By OrderIDGET/v1/orders/b2b/delivery-partners/{dpID}/{orderID}
10Get Order By ExternalRefGET/v1/orders/b2b/delivery-partners/{dpID}/externalref/{externalRefID}

Authentication​

All API requests require authentication headers:

x-client-id: YOUR_CLIENT_ID
x-client-secret: YOUR_CLIENT_SECRET
Content-Type: application/json

Common Response Patterns​

Success Response​

All successful responses include relevant data and follow consistent patterns.

Error Response​

{
"error": "error message",
"errCode": "ERROR_CODE"
}

Pagination​

APIs that return lists include pagination information:

{
"data": [...],
"paginationInfo": {
"nextCursor": "cursor_value",
"hasMore": true
}
}

Rate Limiting​

  • Standard rate limits apply to all endpoints
  • Specific limits are provided with your credentials
  • Production limits may differ from UAT limits

Data Formats​

Date/Time​

All timestamps are in ISO 8601 format (UTC):

2025-08-29T09:50:11.947Z

Currency​

All monetary values are in rupees:

{
"balance": 90000, // Amount in Rupees
"currency": "INR"
}

IDs and References​

  • orderID: System-generated unique order identifier
  • externalRefID: Your unique reference for the order
  • variantID: Product variant identifier
  • dpID: Your delivery partner ID (same as clientID)

API Categories​

Order Management​

Handle the complete order lifecycle from placement to fulfillment.

Product Management​

Access product catalogs and variant information.

Wallet Management​

Monitor wallet balance and transaction history.

Getting Started​

  1. New to the API? Start with Authentication
  2. Ready to test? Try the Quick Start Guide
  3. Need specific endpoint details? Browse the API sections below

Support​

For technical assistance:

  • Live Sessions: Available upon request
  • Documentation: This comprehensive reference guide