This API is used to fetch order details such as order status, date, shipping details, address, products etc.
Available order status are:
Method: GET
URL/Path: baseurl/rest/v3/orders/{order_id}
E.g.: extapi12.budgetree .in/rest/v3/orders/11110010
Request Header:
| Content-Type | application/json |
| Accept | */* |
Request URL Parameters
| Field Name | Data Type | Mandatory/Optional | Description | Example |
| order_id | int | Mandatory | This API retrieves order details of the given orderID. | 11110010 |
Sample Request: For GET calls, request body is not required.
Request Parameters: For GET calls, request parameters are not required.
Sample Response
Sample Response 200
{
"orderId": "796500044",
"refno": "WO-321321312",
"status": "PROCESSING",
"statusLabel": "Business Approved",
"createdBy": "Error! Hyperlink reference not valid.",
"date": "2022-02-18T10:12:07+00:00",
"scheduledDate": "",
"extCustomerId": "Self",
"grandTotal": "100.00",
"subTotal": "100.00",
"discount": 0,
"packaging": {},
"corporateDiscount": {
"label": "Corporate Discount",
"amount": 0,
"percentage": 0
},
"totalQty": 1,
"handlingCharges": {
"label": null,
"amount": null
},
"orderTypeCode": "PAYOUTVALIDATION",
"payout": {
"convenienceCharge": "51.01",
"accountNumber": "XXXXXXXXX3773",
"vpa": "",
"bankUtr": "3213123"
},
"products": [
{
"name": "test-product-rename-5",
"type": "DIGITAL",
"qty": 1,
"price": "100.00",
"total": "100.00",
"discount": "0.00",
"corporateDiscount": {
"label": "Corporate Discount",
"amount": 0,
"percentage": 0
},
"image": {
"thumbnail": "",
"mobile": "",
"base": "",
"small": ""
},
"currency": {
"code": "INR",
"numericCode": "356",
"symbol": "₹"
},
"mergedQty": 0
}
],
"currency": {
"code": "INR",
"numericCode": "356",
"symbol": "₹"
},
"address": {
"salutation": null,
"name": "testCustomerB ",
"line1": "line1",
"line2": "line2",
"line3": "",
"line4": "",
"city": "jind",
"region": "Haryana",
"postcode": "126102",
"country": "India",
"telephone": "+917015063279",
"email": "Error! Hyperlink reference not valid.",
"gstn": null,
"company": null
},
"billing": {
"salutation": null,
"name": "testCustomerB ",
"line1": "line1",
"line2": "line2",
"line3": "",
"line4": "",
"city": "jind",
"region": "Haryana",
"postcode": "126102",
"country": "India",
"telephone": "+917015063279",
"email": "Error! Hyperlink reference not valid.",
"gstn": null,
"company": null
},
"etaMessage": "",
"shipments": [
{
"tracks": []
}
],
"shipping": {
"method": {
"code": "freeshipping",
"label": "Free Shipping",
"amount": 0,
"eta": null
}
},
"payments": [
{
"code": "purchaseorder",
"name": "Purchase Order QA",
"amount": "100.00",
"poNumber": "sarlal132-030361-97"
}
],
"orderType": "Individual Email/SMS",
"fullFilledBySeller": false,
"consolidatedEmailStatus": "NA",
"cardTypes": [
"E-Gift Card"
],
"isMreOrder": false,
"cancel": {
"allowed": true,
"allowedWithIn": 10
},
"bizApprove": {
"status": 0,
"actionDate": null,
"by": null,
"comment": null
},
"additionalTxnFields": {
"remarks": ""
},
"delivery": {
"summary": {
"email": {
"totalCount": 0,
"delivered": 0,
"failed": 0,
"inProgress": 0
},
"sms": {
"totalCount": 0,
"delivered": 0,
"failed": 0,
"inProgress": 0
},
"totalCardsCount": 0
}
},
"cards": {
"summary": {
"success": 0,
"inProgress": 0,
"failed": 0,
"totalCardsCount": 0
}
},
"orderHistory": [
{
"eventGroup": "order_status",
"eventStatus": "success",
"label": "Order Created"
},
{
"eventGroup": "card_status",
"eventStatus": null,
"label": "Cards Activation"
},
{
"eventGroup": "order_status",
"eventStatus": null,
"label": "Order Completed"
},
{
"eventGroup": "email_delivery",
"eventStatus": null,
"label": "Email Delivery"
},
{
"eventGroup": "sms_delivery",
"eventStatus": null,
"label": "SMS Delivery"
}
],
"extensionParams": [],
"orderReceipt": "Error! Hyperlink reference not valid."
}
Sample Response 400
{
"code": 5320,
"message": "Order Not Available",
"messages": []
}
Sample Response 500
{
"code": 500,
"message": "Could not process your request, Please try again later"
}
1. Success
| Field Name | Data Type | Description | Example |
|---|---|---|---|
| orderId | integer | Order identification number generated by QwikGiftAPI | 79000007894 |
| refno | string | Unique id provided by the customer to identify a transaction | WO-321321312 |
| status | string | Current status | COMPLETE |
| statusLabel | string | Order status in required language | Complete |
| createdBy | string | Customer Email Id | Abc123@gmail.com |
| date | string | Order Create date in ISO 8601 | 2021-06-02T10:36:26+00:00 |
| scheduledDate | string | To be ignored | Internal field |
| extCustomerId | string | To be ignored | Internal field |
| grandTotal | string | Order final amount including discount or other charges | 520.00 |
| subtotal | string | Order sub total amount | 500.00 |
| Discount | string | To be ignored | Internal field |
| Discount | string | To be ignored | Internal field |
2. Failure
| Field Name | Data Type | Description | Example |
|---|---|---|---|
| code | number | Error Code | 5320 |
| message | string | Error Message | Order Not Available |
| messages | array |
Note: Please refer to Order API (Create) for length of response parameters.
Last updated on: