Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Transaction

Lets you update deliveryStatus, custom fields, and extended fields of a transaction. Supports REGULAR, RETURN, NOT_INTERESTED, and NOT_INTERESTED_RETURN transaction types.

put/transactions

Query parameters

identifierName'mobile' | 'email' | 'externalId' | 'id' | 'wechat' | 'martjackId' | 'fbId' | 'cardnumber' | 'cardExternalId'
identifierValuestring

Pass the respective identifier value.

source'INSTORE' | 'WECHAT' | 'MARTJACK' | 'WEB_ENGAGE' | 'ECOMMERCE' | 'JD' | 'TAOBAO' | 'TMALL' | 'FACEBOOK' | 'WEBSITE' | 'OTHERS'
accountIdstring

For sources with multiple accounts (such as MARTJACK, WECHAT), pass the respective account ID. Not applicable for INSTORE source.

Headers

X-CAP-DIRECT-REPLAYboolean

Pass true to add the call to the event execution queue (reply event) - in this case, transaction is added and other events will be executed later. Pass false to directly execute the event.

Request body

idinteger

Unique ID of the transaction generated internally.

numberstring

Unique transaction number that needs to be updated.

extendedFieldsobject

Valid transaction level extended field details in name and value pairs.

deliveryStatus'PLACED' | 'PROCESSED' | 'SHIPPED' | 'DELIVERED' | 'RETURNED'

Response

200

Example response

{
  "loyaltyDetails": [
    {
      "expired": 298400,
      "lifetimePoints": 298440,
      "loyaltyPoints": 40,
      "cumulativePurchases": -1199637100,
      "loyaltyId": 92523645,
      "currentSlab": "bronze",
      "nextSlab": "silver",
      "nextSlabSerialNumber": 2,
      "nextSlabDescription": "silver",
      "slabSNo": 1,
      "slabExpiryDate": "2121-03-02T23:59:59+05:30",
      "programId": 1016,
      "totalAvailablePoints": 40,
      "programTitle": "mobile pushDefaultProgram",
      "programDescription": "Default program for mobile push",
      "programPointsToCurrencyRatio": 0.75
    }
  ]
}