Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve Request Details using Type and Subtype

Allows you to retrieve request details with desired filters.

get/requests

Query parameters

requestTypestring required

Type of request. Values: TRANSACTION - For transaction request CHANGE_IDENTIFIER - For customer merge request

requestSubTypestring required

Subtype of the request. Values: REGULAR_TXN_ADD - For transaction request MERGE - For customer merge request

limitinteger

umber of results. For example, number 10 retrieves the first 10 rows of the query results.

offsetstring

Defines the number of rows that needs to be skipped from the beginning of the results. For example, number 10 skips the first 10 search results.

sort'ADDED_ON' | 'LAST_UPDATED_ON'

Sorts the results as per the defined method.

orderstring

Sorts the data in descending or ascending order.

status'PENDING' | 'REJECTED' | 'APPROVED' | 'SUCCESS' | 'FAILURE'

Filter the data by its status.

sourcestring required

Defines the source from which the transaction is made. Example: INSTORE, WECHAT, WEB_ENGAGE (Web-engage integration) etc.

identifierTypestring required

Defines any of the registered identifier name of the customer. Values: mobile, email, externalId, id, WeChat, cardnumber, cardExternalId

identifierValuestring required

Defines the respective identifier value. For example, if identifierType is mobile, identifierValue is mobile number.

Customer identification parameters such as source, account id, identifiers etc.

start_datestring date

Pass the date range in ISO standard - yyyy-mm-ddThh:mm:ss.s+z.

end_datestring date

Pass the date range in ISO standard - yyyy-mm-ddThh:mm:ss.s+z.

Response

200

OR
OR
OR

Example response

{
  "pagination": {
    "limit": 10,
    "sortBy": "created_on",
    "sortOrder": "DESC",
    "total": 988
  },
  "data": [
    {
      "type": "TRANSACTION",
      "baseType": "REGULAR_TXN_ADD",
      "status": "PENDING",
      "transaction": {
        "extendedFields": {
          "checkin_date": "2010-06-04 21:08:12",
          "checkout_date": "2010-06-05 21:08:12",
          "ship_first_name": "Ram",
          "ship_last_name": "Singh"
        },
        "deliveryStatus": "SHIPPED",
        "type": "REGULAR",
        "billAmount": 200,
        "billNumber": "num-1234",
        "discount": 10,
        "grossAmount": 110,
        "note": "This is test",
        "lineItemsV2": [
          {
            "amount": 100.5,
            "itemCode": "sku_234_2",
            "qty": 1,
            "rate": 100.5,
            "returnable": true,
            "returnableDays": -1,
            "extendedFields": {
              "GrossWeight": "10.50",
              "MetalRate": "22.02"
            }
          }
        ],
        "customFields": {
          "paymentmode": "cash"
        },
        "userGroup2Id": 1949,
        "userGroup2PrimaryUserId": 414936033,
        "paymentModes": [
          {
            "mode": "Card Payment",
            "value": 5104,
            "notes": "Sample notes",
            "attributes": {
              "card_type": "Visa"
            }
          }
        ],
        "billingDate": "2023-05-08T20:51:13+05:30"
      },
      "images": [
        {
          "id": 934,
          "provider": "FILESERVICE",
          "namespace": "solutions",
          "serial": 1,
          "fileName": "TestImage.jpeg",
          "imageReference": "bdacb6a7-d4ce-4dea-bf38-134a1200b8b9",
          "filePath": "https://s3.amazonaws.com/fileservice.in/solutions/ebe6ad63-da4c-4dfb-9365-2f8d421.jpeg?X-Amz-Security-Token=FwoGZXIvYXdzEFoaDGIjegsrv1Xa7a%2B9oiLQAa2VFQ4UY0IUnFAbH8TuKWHmpRGsr0lQagsZ%2BJVj7wiEwxoYEsg%2Fa1TtecwDU5nYJZ4HhoU1dRz8BcDTM8v%2Bcgd0ywEOE3Kkwyg5YqPW4L3%2BrJzeEl0R2pDgv%2Bu6uioXnxQE2EmAgTV%2BeIiz5OfyyTHpPlUA7EYyU3pUSrjciT6bMPvMAP%2FEoiKyf2C4KWeYKGRtRmhV3rROWNKGccHjpWYXs70c20RhTGzxibK1qYIAKPcvrNODubcQbahWA7bag658fVsYnlHM5G0TmdMnnYYonbzkogYyLToxrhDfxMghIp90SbouodGENsEWiKO0i4NB35ovbg15szbjMm9tzwfaXqCJ1Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230508T160948Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBYMAOFKMJ%2F20230508%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=190e961ca3064095b4ac62df830297f62f1946dfaef58d0b2a6dce50f6c725c5",
          "securedFilePath": "https://s3.amazonaws.com/fileservice.in/solutions/ebe6ad63-da4c-4dfb-9365-2f8d421.jpeg?X-Amz-Security-Token=FwoGZXIvYXdzEFoaDGIjegsrv1Xa7a%2B9oiLQAa2VFQ4UY0IUnFAbH8TuKWHmpRGsr0lQagsZ%2BJVj7wiEwxoYEsg%2Fa1TtecwDU5nYJZ4HhoU1dRz8BcDTM8v%2Bcgd0ywEOE3Kkwyg5YqPW4L3%2BrJzeEl0R2pDgv%2Bu6uioXnxQE2EmAgTV%2BeIiz5OfyyTHpPlUA7EYyU3pUSrjciT6bMPvMAP%2FEoiKyf2C4KWeYKGRtRmhV3rROWNKGccHjpWYXs70c20RhTGzxibK1qYIAKPcvrNODubcQbahWA7bag658fVsYnlHM5G0TmdMnnYYonbzkogYyLToxrhDfxMghIp90SbouodGENsEWiKO0i4NB35ovbg15szbjMm9tzwfaXqCJ1Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230508T160948Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXKEP2EMBYMAOFKMJ%2F20230508%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=190e961ca3064095b4ac62df830297f62f1946dfaef58d0b2a6dce50f6c725c5",
          "active": true
        }
      ],
      "customer": {
        "id": 536093144,
        "profiles": [
          {
            "firstName": "Dave",
            "lastName": "Maz",
            "identifiers": [
              {
                "type": "email",
                "value": "tom.swayer@capillarytech.com"
              }
            ],
            "userId": 536093144,
            "autoUpdateTime": "2023-05-08T21:39:48+05:30",
            "identifiersAll": [
              {
                "type": "email",
                "value": "tom.swayer@capillarytech.com"
              }
            ]
          }
        ]
      },
      "attribution": {
        "createDate": "2023-05-08T20:51:14+05:30",
        "createdBy": {
          "id": 13539312,
          "code": "neestoretillssnee1",
          "name": "neestoretillssnee1",
          "type": "TILL",
          "adminType": "GENERAL",
          "isActive": true
        },
        "modifiedBy": {
          "id": 13539312,
          "code": "neestoretillssnee1",
          "name": "neestoretillssnee1",
          "type": "TILL",
          "adminType": "GENERAL",
          "isActive": true
        },
        "modifiedDate": "2023-05-08T20:51:14+05:30"
      },
      "id": 978078,
      "addedOn": "2023-05-08T20:51:14+05:30",
      "userId": 536093144,
      "comments": "any comments"
    }
  ]
}