Skip to main content

Get Order by ID

Fetch detailed information for a specific order using the system-generated order ID.

Endpoint​

GET /v1/orders/b2b/delivery-partners/{dpID}/{orderID}

Headers​

HeaderTypeDescriptionRequired
x-client-idStringYour clientID✅ Yes
x-client-secretStringYour clientSecret✅ Yes

Path Parameters​

ParameterTypeDescriptionRequired
dpIDStringYour delivery partner ID✅ Yes
orderIDStringSystem-generated order identifier✅ Yes
Order ID Format

Order IDs follow the pattern: ORDIN{DATE}{RANDOM} (e.g., ORDIN080920252e9625e)

Example Request​

curl --location 'https://stage-platform-exlr8.exlr8now.com/v1/orders/b2b/delivery-partners/YOUR_DP_ID/ORDIN080920252e9625e' \
  --header 'x-client-id: YOUR_CLIENT_ID' \
  --header 'x-client-secret: YOUR_CLIENT_SECRET'

Response​

Successful Response​

{
  "orderID": "ORDIN0912202528cce89",
  "externalRefID": "order-07-09-2025",
  "dpUserEmail": "johndoe@gmail.com",
  "dpUserName": "Demo Intl Test Dp",
  "dpID": "daa30819-8150-4490-b20f-65b75cb148ba",
  "totalOrderMRP": 2448.44,
  "totalAmount": 2448.44,
  "totalCostPrice": 0,
  "dpSellingPrice": 0,
  "subDpSellingPrice": 0,
  "currency": "INR",
  "status": "COMPLETED",
  "fulfillmentStatus": "FULFILLED",
  "createdAt": "2025-12-09T07:40:30.72Z",
  "updatedAt": "2025-12-09T07:40:30.777Z",
  "assetURL": "",
  "type": "DIRECT_CHECKOUT",
  "lineItems": [
    {
      "variantID": "VAR-23c2a475-06cb-4118",
      "productID": "PROD-cd250a2a-2b27-40e0",
      "quantity": 1,
      "mrp": 100,
      "price": 100,
      "totalMRP": 100,
      "totalPrice": 100,
      "totalConvertedPrice": 2448.44,
      "totalItemCostPrice": 0,
      "currency": "AED",
      "fxRate": 24.4844,
      "markUpPercentage": 0,
      "variantName": "TEST_PRODUCT_1_DP_APIS INR 100",
      "productName": "TEST_PRODUCT_1_DP_APIS",
      "variantDisplayName": "₹ 100",
      "productDisplayName": "TEST_PRODUCT_1_DP_APIS",
      "attachments": [
        "https://storage.googleapis.com/exlr8-assets/voucher_bulk_uploads/default_voucher.jpg"
      ],
      "mobileNumbers": null,
      "vouchers": [
        {
          "voucherCode": "89868092",
          "voucherPin": "T5R9-Q2M8-C6V2748",
          "expirationDate": "2028-01-01T00:00:00Z"
        }
      ],
      "fulfillmentStatus": "FULFILLED",
      "allocatedQty": 1,
      "fulfilledQty": 1
    }
  ]
}
Order Currency Conversion

In the order response, the line item currency is AED, and the totalConvertedPrice (2448.44) is calculated by converting the totalPrice (100) using the fxRate (24.4844) to your selected wallet currency (INR). This ensures the order amount deducted from your wallet is in your selected currency.

# Example: Download order assets
curl --location 'https://storage.googleapis.com/exlr8-assets/orders/ORDIN080920252e9625e_order_details.xlsx' \
  --output order_details.xlsx

Error Responses​

Order Not Found​

{
  "error": "order not found with orderID: INVALID_ORDER_ID and dpId: YOUR_DP_ID",
  "errCode": "RECORD_NOT_FOUND"
}

Use Cases​

1. Order Status Updates​

Regularly check order status to provide updates to your customers.

2. Voucher Retrieval​

Download and process voucher information once orders are fulfilled.

3. Customer Support​

Provide detailed order information for customer inquiries.

Best Practices​

  1. Poll Wisely: Don't poll too frequently for status updates
  2. Cache Results: Cache order details to reduce API calls
  3. Handle All States: Implement logic for all possible order states
  4. Secure Asset Handling: Properly handle and store downloaded voucher files