get
https://{host}/v2/requests
Allows you to retrieve request details with desired filters.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Example request
curl --location 'https://eu.api.capillarytech.com/v2/requests?requestType=TRANSACTION&requestSubType=REGULAR_TXN_ADD' \
--header 'Authorization: Basic bWFkaHV3MjU2YQ==' \
--header 'Cookie: _cfuvid=zP64VTj6GdUFYZ2gjEkFMJ0lr.yGY2xiKhDjAViECSE-1772457459807-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v2/requests?requestType=CHANGE_IDENTIFIER&requestSubType=MERGE' \
--header 'Authorization: Basic bWFkaHVzI3MjU2YQ==' \
--header 'Cookie: _cfuvid=zP64VTj6GdUFYZ2gjEkFMJ0lr.yGY2xiKhDjAViECSE-1772457459807-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v2/requests?requestType=CHANGE_IDENTIFIER&requestSubType=MERGE' \
--header 'Authorization: Basic YXV0b3N0bJkMjM0Yjcw'curl --location 'https://eu.api.capillarytech.com/v2/requests?requestType=CHANGE_IDENTIFIER&requestSubType=MERGE' \
--header 'Authorization: Basic YXV0bNTJkMjM0Yjcw'Prerequisites
Authentication - Basic or OAuth authentication
Access group resource - Read permission on Requests resource group
Resource information
| URI | v2/requests |
| HTTP method | GET |
| Pagination supported? | Yes. Sorting is also supported. |
| Batch support | NA |
Query parameters
| Parameter | Data Type | Description |
|---|---|---|
requestType* |
Enum |
Type of request. Possible Values: |
requestSubType* |
Enum |
Subtype of the request. |
limit |
Integer |
Number of request details to display per page. For example, if the total is 15 and the limit is 5, the first page will display the first 5 records. The maximum supported limit is 50. |
offset |
Integer |
Page number to retrieve. To view the first page, set the value to 0. |
sort |
String |
Sorts the results. Possible Values: |
order |
String |
Sorts the data in either ascending or descending order. Possible Values: |
status |
Enum |
Filters the data by its status. Possible values: |
Customer identification |
Object |
Customer identification parameters such as source, account id, identifiers etc. |
start_date |
Date |
Pass the date range in ISO standard - yyyy-mm-ddThh:mm:ss.s+z. Example: If you want to show the requests from April 1st, 2025, set start_date=2025-04-01T00:00:00Z |
end_date |
Date |
Pass the date range in ISO standard - yyyy-mm-ddThh:mm:ss.s+z. Example: If you want to show the requests until April 30th, 2025, set end_date=2025-04-30T00:00:00Z |
Note: The parameters marked with an asterisk (*) indicate that they are mandatory and must be provided in the API request.
Example response
{
"pagination": {
"limit": 10,
"offset": 0,
"sortBy": "r.created_on",
"sortOrder": "DESC",
"total": 37
},
"data": [
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"type": "REGULAR",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2025-04-29T04:30:00Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T14:02:32Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T14:02:32Z"
},
"id": 29592579,
"addedOn": "2026-02-23T14:02:32Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"type": "REGULAR",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2025-04-29T04:30:00Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T14:02:27Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T14:02:27Z"
},
"id": 29592578,
"addedOn": "2026-02-23T14:02:27Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"type": "REGULAR",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2025-04-29T04:30:00Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T14:01:37Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T14:01:37Z"
},
"id": 29592266,
"addedOn": "2026-02-23T14:01:37Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T13:45:37Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T13:45:37Z"
},
"id": 29586874,
"addedOn": "2026-02-23T13:45:37Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"type": "REGULAR",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"billingDate": "2025-04-29T04:30:00Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T13:40:49Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T13:40:49Z"
},
"id": 29585202,
"addedOn": "2026-02-23T13:40:49Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"billAmount": 6000,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2026-02-23T13:40:16Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T13:40:17Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T13:40:17Z"
},
"id": 29584811,
"addedOn": "2026-02-23T13:40:17Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"billAmount": 6000,
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2026-02-23T13:40:11Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T13:40:12Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T13:40:12Z"
},
"id": 29584810,
"addedOn": "2026-02-23T13:40:12Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2026-02-23T13:40:07Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T13:40:08Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T13:40:08Z"
},
"id": 29584809,
"addedOn": "2026-02-23T13:40:08Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"type": "REGULAR",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2025-04-29T04:30:00Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T13:38:39Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T13:38:39Z"
},
"id": 29584495,
"addedOn": "2026-02-23T13:38:39Z",
"userId": 564703252,
"oneStep": false
},
{
"type": "TRANSACTION",
"baseType": "REGULAR_TXN_ADD",
"status": "PENDING",
"transaction": {
"deliveryStatus": "PLACED",
"type": "REGULAR",
"billAmount": 6000,
"billNumber": "test00transact088",
"discount": 0,
"grossAmount": 6000,
"note": "Add Transaction Request 88",
"lineItemsV2": [
{
"amount": 6000,
"description": "sports shoes",
"discount": 0,
"itemCode": "model_id_001",
"qty": 3,
"rate": 2000,
"returnable": true,
"returnableDays": -1,
"comboDetails": [],
"addOnDetails": [],
"splitDetails": []
}
],
"notInterestedReason": "",
"isUseDefaultUserGroup2": false,
"paymentModes": [
{
"mode": "Cash",
"value": 6000,
"notes": ""
}
],
"billingDate": "2025-04-29T04:30:00Z",
"useDefaultUserGroup2": false
},
"customer": {
"id": 564703252,
"profiles": [
{
"firstName": "Tjuser",
"lastName": "Eightysix",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
],
"commChannels": [],
"userId": 564703252,
"accountId": "",
"autoUpdateTime": "2026-03-03T12:39:33Z",
"identifiersAll": [
{
"type": "externalId",
"value": "0000011110"
},
{
"type": "mobile",
"value": "919999988886"
},
{
"type": "email",
"value": "[email protected]"
}
]
}
]
},
"attribution": {
"createDate": "2026-02-23T05:59:53Z",
"createdBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedBy": {
"id": 75197372,
"code": "madhu_rima",
"description": "madhurima's till",
"name": "madhurima",
"type": "TILL",
"referenceId": -1,
"adminType": "GENERAL",
"isActive": true,
"isOuEnabled": false,
"timeZoneId": 191,
"currencyId": 0,
"languageId": 0,
"default": false
},
"modifiedDate": "2026-02-23T05:59:53Z"
},
"id": 29487591,
"addedOn": "2026-02-23T05:59:53Z",
"userId": 564703252,
"oneStep": false
}
],
"warnings": [],
"errors": []
}{
"pagination": {
"limit": 10,
"offset": 0,
"sortBy": "r.created_on",
"sortOrder": "DESC",
"total": 83
},
"data": [
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1107529,
"userId": -1,
"requestId": 13675913,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "566196275"
}
],
"remove": [
{
"type": "id",
"value": "566186920"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1085923,
"userId": -1,
"requestId": 13607298,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "564661993"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045866,
"userId": -1,
"requestId": 13552463,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "566727315"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045846,
"userId": -1,
"requestId": 13552401,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "566907117"
}
],
"remove": [
{
"type": "id",
"value": "564661993"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045845,
"userId": -1,
"requestId": 13552400,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "564661993"
}
],
"remove": [
{
"type": "id",
"value": "565409418"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045844,
"userId": -1,
"requestId": 13552399,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "564661993"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045840,
"userId": -1,
"requestId": 13552391,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "564661993"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045799,
"userId": -1,
"requestId": 13552011,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "566727315"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045798,
"userId": -1,
"requestId": 13552010,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "566727315"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2026-03-03T12:51:44Z",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2026-03-03T12:51:44Z"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 1045797,
"userId": -1,
"requestId": 13552003,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "566727315"
}
],
"remove": [
{
"type": "id",
"value": "566907117"
}
]
},
"oneStep": false
},
"oneStep": false
}
],
"warnings": [],
"errors": []
}{
"pagination": {
"limit": 10,
"offset": 0,
"sortBy": "r.created_on",
"sortOrder": "DESC",
"total": 5
},
"data": [
{
"attribution": {
"createDate": "2025-03-21T11:07:56+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:07:56+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 843372,
"userId": -1,
"requestId": 1778080,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387733529"
}
],
"remove": [
{
"type": "id",
"value": "387733597"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2025-03-21T11:07:56+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:07:56+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 842617,
"userId": -1,
"requestId": 1774973,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387724145"
}
],
"remove": [
{
"type": "id",
"value": "387724147"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2025-03-21T11:07:56+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:07:56+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 842614,
"userId": -1,
"requestId": 1774969,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387724145"
}
],
"remove": [
{
"type": "id",
"value": "387724147"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2025-03-21T11:07:56+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:07:56+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 842574,
"userId": -1,
"requestId": 1774882,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387724145"
}
],
"remove": [
{
"type": "id",
"value": "387724147"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2025-03-21T11:07:56+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:07:56+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 825524,
"userId": -1,
"requestId": 1704615,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387480176"
}
],
"remove": [
{
"type": "id",
"value": "387480177"
}
]
},
"oneStep": false
},
"oneStep": false
}
],
"warnings": [],
"errors": []
}{
"pagination": {
"limit": 10,
"offset": 0,
"sortBy": "r.created_on",
"sortOrder": "DESC",
"total": 3
},
"data": [
{
"attribution": {
"createDate": "2025-03-21T11:00:19+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:00:19+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 843373,
"userId": -1,
"requestId": 1778080,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387733529"
}
],
"remove": [
{
"type": "id",
"value": "387733597"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2025-03-21T11:00:19+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:00:19+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 842618,
"userId": -1,
"requestId": 1774973,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387724145"
}
],
"remove": [
{
"type": "id",
"value": "387724147"
}
]
},
"oneStep": false
},
"oneStep": false
},
{
"attribution": {
"createDate": "2025-03-21T11:00:19+05:30",
"createdBy": {
"referenceId": -1,
"default": false
},
"modifiedBy": {
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-21T11:00:19+05:30"
},
"userId": -1,
"changeIdentifierRequest": {
"id": 842615,
"userId": -1,
"requestId": 1774969,
"changeIdentifiers": {
"add": [
{
"type": "id",
"value": "387724145"
}
],
"remove": [
{
"type": "id",
"value": "387724147"
}
]
},
"oneStep": false
},
"oneStep": false
}
],
"warnings": [],
"errors": []
}Response parameters for Transaction
| Parameter | Description |
|---|---|
| type | Type of request. In this case, it is "TRANSACTION". |
| baseType | Subtype of the request. In this case, it is "REGULAR_TXN_ADD". |
| status | Status of the transaction. In this case, it is "PENDING". |
| checkin_date | Date and time of check-in for the transaction. |
| checkout_date | Date and time of check-out for the transaction. |
| ship_first_name | First name of the shipping recipient. |
| ship_last_name | Last name of the shipping recipient. |
| deliveryStatus | Current delivery status of the transaction. |
| type | Type of transaction. In this case, it is "REGULAR". |
| billAmount | Total bill amount for the transaction. |
| billNumber | Bill number associated with the transaction. |
| discount | Discount amount applied to the transaction. |
| grossAmount | Gross amount of the transaction. |
| note | Additional notes or comments related to the transaction. |
| lineItemsV2 | Array containing details of individual line items in the transaction. |
| paymentmode | Payment mode used for the transaction. In this case, it is "cash". |
| userGroup2Id | Identifier for the second user group. |
| userGroup2ExternalId | External identifier for the second user group. |
| userGroup2PrimaryUserId | Primary user ID associated with the second user group. |
| isUseDefaultUserGroup2 | Boolean value indicating if the default user group is used for the second user group. |
| paymentModes | Array containing details of payment modes used for the transaction. |
| billingDate | Date and time of billing for the transaction. |
| customer | Object containing customer information for the transaction. |
| attribution | Object containing details about the creation and modification of the transaction. |
| id | Unique request identifier for the transaction request. |
| addedOn | Date and time when the transaction was added. |
| userId | User ID associated with the transaction. |
| comments | Comments or description related to the transaction. |
| oneStep | Boolean value indicating if the transaction is a one-step process. |
Please note that some parameters have sub-fields, such as "extendedFields" and "paymentModes," which contain additional details. These can be represented in the table as needed.
Response Parameters for Customer Merge
| Parameter | Data Type | Description |
|---|---|---|
| pagination | Object | Contains pagination details |
| Integer | Maximum number of records returned per page |
| Integer | Number of records skipped before returning results |
| String | Field used to sort the data |
| String | Sorting order. Possible Value: ASC or DESC |
| Integer | Total number of records available |
| data | Array | List of change identifier request entries |
| Object | Metadata related to creation and modification |
| -- createDate | Date | Timestamp when the entry was created in ISO 8601 format |
| -- createdBy | Object | Information about the creator |
| --- referenceId | Integer | ID of the user that created the entry |
| --- default | Boolean | Indicates if the default user was used |
| -- modifiedBy | Object | Information about the last modifier |
| --- referenceId | Integer | ID of the user who last modified the entry |
| --- default | Boolean | Indicates if the default user was used |
| -- modifiedDate | Date | Timestamp when the entry was last modified in ISO 8601 format |
| Integer | User ID associated with the request |
| Object | Details of the identifier change request |
| -- id | Long | Unique ID of the change identifier request |
| -- userId | Long | User ID associated with the identifier change |
| -- requestId | Long | Request ID tied to the identifier change |
| -- changeIdentifiers | Object | Identifiers to be added or removed |
| --- add | Array | List of identifiers of the survivor |
| ---- type | String | Type of identifier. Possible Values: id, email |
| ---- value | String | Value of the identifier of the survivor |
| --- remove | Array | List of identifiers of the victim |
| ---- type | String | Type of identifier. Possible Values: id, email |
| ---- value | String | Value of the identifier of the victim |
| -- oneStep | Boolean | Indicates whether the change is processed in one step for the changeIdentifiers object |
| Boolean | Indicates whether the change is processed in one step for the changeIdentifierRequest object |
| warnings | Array | List of warnings (if any) |
| errors | Array | List of errors (if any) |
Error Code
| Error Code | Description | Reason |
|---|---|---|
| 403 | Field Request subtype is mandatory | Subtype is missing in the request |