Order Search

Developing

POST

/api/v0/partner/search-order

Request

Query Params

Header Params

Body Params application/json

Example

{ "aggregator": "ADVANTAGE_CLUB", "aggregatorDiscountFrom": 0, "aggregatorDiscountTo": 0, "aggregatorOrderId": "string", "aggregatorProductId": "string", "amountFrom": 0, "amountTo": 0, "brand": [ "string" ], "category": [ "string" ], "companyId": "string", "createdOnFrom": "yyyy-MM-dd", "createdOnTo": "yyyy-MM-dd", "direction": "ASC", "ekUserId": "string", "email": "string", "enkashDiscountFrom": 0, "enkashDiscountTo": 0, "limit": 0, "mobile": "string", "offset": 0, "orderAmountFrom": 0, "orderAmountTo": 0, "orderDetailsId": "string", "orderId": "string", "orderIds": [ "string" ], "orderStatus": "APPROVAL_PENDING", "paidAmountFrom": 0, "paidAmountTo": 0, "paymentStatus": "AUTHENTICATION_IN_PROCESS", "product": "CHANNEL_OPEN_VOUCHER", "profitPayoutFlag": true, "purchaseDateFrom": "yyyy-MM-dd", "purchaseDateTo": "yyyy-MM-dd", "refundDateFrom": "yyyy-MM-dd", "refundDateTo": "yyyy-MM-dd", "totalDiscountFrom": 0, "totalDiscountTo": 0, "transactionId": "string", "utmSource": "string", "voucherMrpFrom": 0, "voucherMrpTo": 0, "voucherQuantityFrom": 0, "voucherQuantityTo": 0}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test.your-api-server.com/api/v0/partner/search-order?limit=10&offset=0' \
--header 'authorization: Bearer 23R9NAVSAH9-ApAfRx_6nSoy1LY' \
--header 'Content-Type: application/json' \
--data-raw '{ "aggregator": "ADVANTAGE_CLUB", "aggregatorDiscountFrom": 0, "aggregatorDiscountTo": 0, "aggregatorOrderId": "string", "aggregatorProductId": "string", "amountFrom": 0, "amountTo": 0, "brand": [ "string" ], "category": [ "string" ], "companyId": "string", "createdOnFrom": "yyyy-MM-dd", "createdOnTo": "yyyy-MM-dd", "direction": "ASC", "ekUserId": "string", "email": "string", "enkashDiscountFrom": 0, "enkashDiscountTo": 0, "limit": 0, "mobile": "string", "offset": 0, "orderAmountFrom": 0, "orderAmountTo": 0, "orderDetailsId": "string", "orderId": "string", "orderIds": [ "string" ], "orderStatus": "APPROVAL_PENDING", "paidAmountFrom": 0, "paidAmountTo": 0, "paymentStatus": "AUTHENTICATION_IN_PROCESS", "product": "CHANNEL_OPEN_VOUCHER", "profitPayoutFlag": true, "purchaseDateFrom": "yyyy-MM-dd", "purchaseDateTo": "yyyy-MM-dd", "refundDateFrom": "yyyy-MM-dd", "refundDateTo": "yyyy-MM-dd", "totalDiscountFrom": 0, "totalDiscountTo": 0, "transactionId": "string", "utmSource": "string", "voucherMrpFrom": 0, "voucherMrpTo": 0, "voucherQuantityFrom": 0, "voucherQuantityTo": 0}'

Responses

🟢200Success

application/json

Body

Example

{
    "payload": {
        "recordsCount": 5,
        "data": [
            {
                "orderId": "OR828419Y5FIW",
                "transactionId": "EK58779I3ZJ",
                "paidVia": "anXXXXXXXXX@okicici",
                "totalAmount": 11.00,
                "totalQuantity": 1,
                "orderAmount": 10.59,
                "paidAmount": 10.59,
                "savings": 0.41,
                "createdOn": "2024-10-04T11:36:41",
                "txnMessage": "Transaction completed.",
                "surcharge": 0.0000,
                "surchargeGst": 18.0000,
                "pgName": "Olympus PG",
                "ekUserId": "EKNWUHLN",
                "email": "[email protected]",
                "mobile": "9660686687",
                "finalStatus": "SUCCESS",
                "companyId": "CEKLVET46Q",
                "product": "VOUCHER",
                "status": "SUCCESS"
            },
            {
                "orderId": "OR849068BBKO0",
                "transactionId": "EK781362HQG",
                "paidVia": "anXXXXXXXXX@okicici",
                "totalAmount": 10.00,
                "totalQuantity": 1,
                "orderAmount": 9.63,
                "paidAmount": 9.63,
                "savings": 0.37,
                "createdOn": "2024-09-13T18:13:15",
                "txnMessage": "Transaction completed.",
                "surcharge": 0.0000,
                "surchargeGst": 18.0000,
                "pgName": "Olympus PG",
                "ekUserId": "EKNWUHLN",
                "email": "[email protected]",
                "mobile": "9660686687",
                "finalStatus": "SUCCESS",
                "companyId": "CEKLVET46Q",
                "product": "VOUCHER",
                "status": "SUCCESS"
            },
            {
                "orderId": "OR807783DVFBZ",
                "transactionId": "EK85571ZCN3",
                "paidVia": "anXXXXXXXXX@okicici",
                "totalAmount": 750.00,
                "totalQuantity": 2,
                "orderAmount": 742.50,
                "paidAmount": 742.50,
                "savings": 7.5,
                "createdOn": "2024-08-13T16:57:53",
                "txnMessage": "Transaction completed.",
                "surcharge": 0.0000,
                "surchargeGst": 18.0000,
                "pgName": "Olympus PG",
                "ekUserId": "EKNWUHLN",
                "email": "[email protected]",
                "mobile": "9660686687",
                "finalStatus": "SUCCESS",
                "companyId": "CEKLVET46Q",
                "product": "VOUCHER",
                "status": "SUCCESS"
            },
            {
                "orderId": "OR096444F9W3Z",
                "transactionId": "EK90234ILP2",
                "paidVia": "anXXXXXXXXX@okicici",
                "totalAmount": 10.00,
                "totalQuantity": 1,
                "orderAmount": 9.82,
                "paidAmount": 9.82,
                "savings": 0.18,
                "createdOn": "2024-08-13T15:50:08",
                "txnMessage": "Transaction completed.",
                "surcharge": 0.0000,
                "surchargeGst": 18.0000,
                "pgName": "Olympus PG",
                "ekUserId": "EKNWUHLN",
                "email": "[email protected]",
                "mobile": "9660686687",
                "finalStatus": "SUCCESS",
                "companyId": "CEKLVET46Q",
                "product": "VOUCHER",
                "status": "SUCCESS"
            },
            {
                "orderId": "OR130130HKQXN",
                "transactionId": "EK50710Y8AA",
                "paidVia": "anXXXXXXXXX@okicici",
                "totalAmount": 50.00,
                "totalQuantity": 1,
                "orderAmount": 48.25,
                "paidAmount": 48.25,
                "savings": 1.75,
                "createdOn": "2023-11-24T18:07:09",
                "txnMessage": "Transaction completed.",
                "surcharge": 0.0000,
                "surchargeGst": 0.0000,
                "pgName": "Enkash_PGM",
                "ekUserId": "EKNWUHLN",
                "email": "[email protected]",
                "mobile": "9660686687",
                "finalStatus": "SUCCESS",
                "companyId": "CEKLVET46Q",
                "product": "VOUCHER",
                "status": "SUCCESS"
            }
        ]
    },
    "response_code": 0,
    "response_message": "Success"
}

Modified at 2025-01-25 10:02:12

Create Order

create order