Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Retro Requests

Retrieves the summary of change in identifiers and other details such as email ID, mobile number, external ID, account merge, address change, mobile number reallocation, tier, and retro transactions.

get/customers/lookup/retroRequest

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP.' required

Source in which the identifier is available.

accountIdstring

Account ID for sources that support multiple accounts.

identifierName'mobile' | 'email' | 'externalId' | 'cardExternalId' | 'cardNumber' required

Name of the identifier used to fetch the customer's change requests.

identifierValuestring required

Value of the specified identifier type.

changeType'EMAIL' | 'MOBILE' | 'MERGE' | 'ADDRESS' | 'MOBILE_REALLOC' | 'COUPON' | 'POINTS' | 'TIER' | 'RETRO'

Lets you filter requests by type. Value: EMAIL (for email id changes), MOBILE (for mobile number change history), EXTERNAL_ID (for external ID change history), MERGE (for account merge history), ADDRESS (for address change history), MOBILE_REALLOC (for mobile reallocations), COUPON, POINTS, TIER (for tier change history), and RETRO (for retro transactions).

startDatestring date

Filter results by date-range. Pass the start date in YYYY-MM-DD format.

endDatestring date

Filter results by date-range. Pass the end date in YYYY-MM-DD format.

startIdinteger

Filter results by sequence ID (sequence in which a change happened). For example, get lists from startId 200

endIdinteger

Filter results by sequence ID (sequence in which a change happened). For example, get lists from startId 200 until endId 400.

offsetinteger

Number of rows that you want to omit from showing.

limitinteger

Pass the number of results that you want to see.

Response

200

Example response

{
  "pagination": {
    "limit": 10,
    "total": 5
  },
  "data": [
    {
      "id": 5,
      "status": "REJECTED",
      "addedBy": {
        "id": 15091433,
        "code": "till.india1",
        "name": "till.india1",
        "type": "TILL",
        "adminType": "GENERAL",
        "isActive": true
      },
      "addedByParent": {
        "id": 15091431,
        "code": "store_india",
        "name": "StoreIndia",
        "type": "STORE",
        "adminType": "GENERAL",
        "isActive": true,
        "currencyId": 23,
        "languageId": 148
      },
      "updatedBy": {
        "id": 8730028,
        "code": "Patel",
        "name": "Nayan Kumar",
        "type": "ADMIN_USER",
        "adminType": "GENERAL",
        "isActive": true
      },
      "addedOn": "2015-07-22T15:48:15+05:30",
      "updatedOn": "2015-10-13T16:04:38+05:30",
      "userId": 9113108,
      "requestId": 116681,
      "baseType": "RETRO",
      "reason": "_memcare(\"Insufficient validation from requestor d",
      "comments": "操作已失败于服务器。错误讯",
      "transactionId": 2866,
      "reqAdd": true
    }
  ]
}