post https://{host}/v1.1/transaction/update
Lets you update transaction level and transaction line-item level custom fields, extended fields details, associated till, and transaction notes.
It also allows converting a not_interested transaction to a regular transaction (Retro Transaction).
Rate Limit
| Region | Default Limit (RPM) |
|---|---|
| Asia-2 (Singapore) | 1500 |
| Asia-1 (N. Virginia) | 200 |
| EMEA (Ireland) | 100 |
Request Body Parameters
| Parameter | Type | Description |
|---|---|---|
| id | int | Unique id of the transaction that you want to update. |
| number | string | Transaction number that you need to update. |
| mobile/email/id/external_id | string | Pass any of the identifiers of the customer associated to the transaction. |
| delivery_status | string | Status of the delivery associated to the transaction update. |
| extended_fields | obj | Update extended field details of the transaction. |
| custom_fields | obj | Update custom field details of the transaction. |
| old_type | enum | Earlier type of transaction. Usually, it will be NOT_INTERESTED. Applicable for retro conversion. |
Response Parameters
| Parameter | Datatype | Description |
|---|---|---|
| extended_fields | obj | Extended field details of the transaction that are updated. |
| custom_fields | obj | Custom field details of the transaction that are updated. |
| id | long | Unique ID of the transaction generated by the system. |
| number | string | Bill or transaction number. |
| type | enum | Current transaction type. |
| customer | obj | Customer details associated to the transaction. |
Note-Custom fields can only be added if they meet the following conditions:
- The field must exist in the
custom_fieldstable for the particular org- It must belong to the same
org_idas the current use-case- The field’s scope must be set to
LOYALTY_REGISTRATION
Note - Transaction Line Item Extended fields must pass the following validations:
- Name Validation: The field name must exist in the extended fields configuration
- Rule Validation: The field must be found in the extended fields table for the organization (org_id) and scope combination
- Data Type Validation: The provided value must match the expected data type of the field