v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

List Member's Transaction API

get/transactions

Query parameters

start_cursorinteger

Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.

countinteger

Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.

approved_datestring

This can be used to filter the list of transactions based on their approved_date in Zinrelo. Child parameters are: p>To filter dates 'equal to' a particular date, use operator "eq". Example: approved_date={"eq":"01/21/2022"} To filter dates 'greater than' a particular date, use operator "gt". Example: approved_date={"gt":"01/21/2022"} To filter dates 'greater than or equal to' a particular date, use operator "gte". Example: approved_date={"gte":"01/21/2022"} To filter dates 'lesser than' a particular date, use operator "lt". Example: approved_date={"lt":"01/21/2022"} To filter dates 'lesser than or equal to' a particular date, use operator "lte". Example: approved_date={"lte":"01/21/2022"} To filter dates 'between' a particular date, use operator "between". Example: approved_date={"between":"12/01/2021-12/31/2022"} Note: Our API records all date and time fields in UTC time.

created_datestring

This can be used to filter the list of transactions based on their created_date in Zinrelo. Child parameters are p>To filter dates 'equal to' a particular date, use operator "eq". Example: created_date={"eq":"01/21/2022"} To filter dates 'greater than' a particular date, use operator "gt". Example: created_date={"gt":"01/21/2022"} To filter dates 'greater than or equal to' a particular date, use operator "gte". Example: created_date={"gte":"01/21/2022"} To filter dates 'lesser than' a particular date, use operator "lt". Example: created_date={"lt":"01/21/2022"} To filter dates 'lesser than or equal to' a particular date, use operator "lte". Example: created_date={"lte":"01/21/2022"} To filter dates 'between' a particular date, use operator "between". Example: created_date={"between":"12/01/2021-12/31/2022"} Note: Our API records all date and time fields in UTC time.

last_modified_datestring

This can be used to filter the list of transactions based on their last_modified date in Zinrelo. Child parameters are: To filter dates 'equal to' a particular date, use operator "eq". Example: last_modified_date={"eq":"01/21/2022"} To filter dates 'greater than' a particular date, use operator "gt". Example: last_modified_date={"gt":"01/21/2022"} To filter dates 'greater than or equal to' a particular date, use operator "gte". Example: last_modified_date={"gte":"01/21/2022"} To filter dates 'lesser than' a particular date, use operator "lt". Example: last_modified_date={"lt":"01/21/2022"} To filter dates 'lesser than or equal to' a particular date, use operator "lte". Example: last_modified_date={"lte":"01/21/2022"} To filter dates 'between' a particular date, use operator "between". Example: last_modified_date={"between":"12/01/2021-12/31/2022"} Note: Our API records all date and time fields in UTC time.

points_expiration_datestring

This can be used to filter the list of transactions based on their points_expiration_date in Zinrelo. Child parameters are: To filter dates 'equal to' a particular date, use operator "eq". Example: points_expiration_date={"eq":"01/21/2022"} To filter dates 'greater than' a particular date, use operator "gt". Example: points_expiration_date={"gt":"01/21/2022"} To filter dates 'greater than or equal to' a particular date, use operator "gte". Example: points_expiration_date={"gte":"01/21/2022"} To filter dates 'lesser than' a particular date, use operator "lt". Example: points_expiration_date={"lt":"01/21/2022"} To filter dates 'lesser than or equal to' a particular date, use operator "lte". Example: points_expiration_date={"lte":"01/21/2022"} To filter dates 'between' a particular date, use operator "between". Example: points_expiration_date={"between":"12/01/2021-12/31/2022"} Note: Our API records all date and time fields in UTC time.

points_statusstring

This filter will return the point status. The value can be passed as: eq: Accepted values are ‘approved, rejected, pending, redeemed, deducted, expired, redemption_pending, redemption_cancelled, pending_deduction, auto_rejected and auto_approved.' Pass the value of the status to get a list of all transactions with points_status equal to the value passed. For example- {"eq":"approved"} in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed. For example- {"in":"approved, rejected"}

statusstring

This filter will return transaction status. eq: Accepted values are Approved/ Rejected/ Pending. For example- {"eq":"approved"} in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed. For example- {"in":"approved, rejected"}

languagestring

One of the store languages, for example english/ italian/ german, etc.

Response

200

totalinteger

The total number of member's transactions.

next_cursorinteger

This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.

moreboolean

Example response

{
  "total": 10,
  "next_cursor": 100,
  "transactions": [
    {
      "status": "approved",
      "auto_approval_date": "",
      "last_modified_date": "12-Sep-2023 10:11:20",
      "award_info": {
        "activity_id": "winback_bonus",
        "points": 100,
        "points_status": "approved",
        "activity_name": "Winback Bonus"
      },
      "member_id": "johndoe",
      "points_expiration_date": "13-Sep-2023 00:00:00",
      "approved_date": "12-Sep-2023 10:11:20",
      "created_date": "12-Sep-2023 10:11:20",
      "transaction_type": "award",
      "transaction_attributes": {
        "reason": "cartabondoned"
      },
      "id": "65003948ebeffa000ccc6bb8"
    },
    {
      "status": "approved",
      "auto_approval_date": "15-Nov-20232 16:10:00",
      "last_modified_date": "12-Sep-2023 10:14:18",
      "award_info": {
        "activity_id": "upload_photo",
        "points": 500,
        "points_status": "expired",
        "activity_name": "Upload a Photo"
      },
      "member_id": "johndoe",
      "points_expiration_date": "06-Oct-2019 00:00:00",
      "approved_date": "12-Sep-2023 10:01:36",
      "created_date": "12-Sep-2023 10:01:19",
      "transaction_type": "award",
      "transaction_attributes": {
        "reason": "photouploaded"
      },
      "id": "650036efebeffa00099d54ba"
    },
    {
      "status": "approved",
      "auto_approval_date": "",
      "last_modified_date": "12-Sep-2023 10:14:18",
      "award_info": {
        "activity_id": "submit_a_receipt",
        "points": 9,
        "points_status": "expired",
        "activity_name": "Submit a Receipt"
      },
      "member_id": "johndoe",
      "points_expiration_date": "06-Oct-2019 00:00:00",
      "approved_date": "12-Sep-2023 10:00:34",
      "created_date": "12-Sep-2023 10:00:17",
      "transaction_type": "award",
      "transaction_attributes": {
        "receipt_file_url": [
          "https://zinrelo-receipt-uploads.s3.amazonaws.com/c944754e96693d3cce82bc3ebcda9f9e.jpg"
        ]
      },
      "id": "650036b1c13154000c365f21"
    },
    {
      "status": "approved",
      "auto_approval_date": "",
      "last_modified_date": "12-Sep-2023 10:29:36",
      "award_info": {
        "activity_id": "made_a_purchase",
        "points": 1000,
        "points_status": "approved",
        "activity_name": "Purchase on website"
      },
      "member_id": "johndoe",
      "points_expiration_date": "13-Sep-2023 00:00:00",
      "approved_date": "12-Sep-2023 10:29:36",
      "created_date": "12-Sep-2023 00:00:00",
      "transaction_type": "award",
      "transaction_attributes": {
        "order_id": "7587746",
        "coupon_code": "$5OFFVYZ",
        "reason": "purchase"
      },
      "id": "65003d91e410b900092ef4e4"
    },
    {
      "status": "approved",
      "transaction_attributes": {},
      "last_modified_date": "08-Aug-2023 06:04:37",
      "member_id": "johndoe",
      "approved_date": "08-Aug-2023 06:04:37",
      "reward_info": {
        "reward_name": "$5 OFF COUPON",
        "points_status": "redeemed",
        "coupon_code": "3193E86A",
        "reward_id": "reward_bc668",
        "points": 500
      },
      "transaction_type": "redeem",
      "id": "64d1daf5339122000c4c3c0a",
      "created_date": "08-Aug-2023 06:04:37"
    },
    {
      "status": "approved",
      "transaction_attributes": {
        "reason": "Testing"
      },
      "last_modified_date": "05-May-2023 10:05:43",
      "transaction_type": "deduct",
      "approved_date": "05-May-2023 10:04:31",
      "member_id": "johndoe",
      "created_date": "05-May-2023 10:04:31",
      "id": "6454d4af3953d5000ccc3c26",
      "deduct_info": {
        "points": 10,
        "points_status": "deducted"
      }
    },
    {
      "status": "approved",
      "transaction_attributes": {
        "reason": "Testing"
      },
      "last_modified_date": "05-May-2023 10:00:09",
      "transaction_type": "deduct",
      "approved_date": "05-May-2023 09:59:28",
      "member_id": "johndoe",
      "created_date": "05-May-2023 09:59:28",
      "id": "6454d38077b86b000d2e555a",
      "deduct_info": {
        "points": 10,
        "points_status": "deducted"
      }
    },
    {
      "status": "approved",
      "transaction_attributes": {
        "reason": "Testing"
      },
      "last_modified_date": "05-May-2023 10:00:09",
      "transaction_type": "deduct",
      "approved_date": "05-May-2023 09:54:10",
      "member_id": "johndoe",
      "created_date": "05-May-2023 09:54:10",
      "id": "6454d2422e7adb000a78f2c5",
      "deduct_info": {
        "points": 10,
        "points_status": "deducted"
      }
    },
    {
      "status": "approved",
      "auto_approval_date": "",
      "last_modified_date": "12-Sep-2023 10:14:18",
      "award_info": {
        "activity_id": "created_an_account",
        "points": 10000,
        "points_status": "expired",
        "activity_name": "Account Creation"
      },
      "member_id": "johndoe",
      "points_expiration_date": "06-Oct-2019 00:00:00",
      "approved_date": "05-May-2023 07:44:43",
      "created_date": "05-May-2023 07:44:43",
      "transaction_type": "award",
      "transaction_attributes": {},
      "id": "6454b3ebe8d4a8000b15cc77"
    },
    {
      "status": "approved",
      "auto_approval_date": "",
      "last_modified_date": "12-Sep-2023 10:14:18",
      "award_info": {
        "activity_id": "made_a_purchase",
        "points": 1000,
        "points_status": "expired",
        "activity_name": "Purchase on website"
      },
      "member_id": "johndoe",
      "points_expiration_date": "06-Oct-2019 00:00:00",
      "approved_date": "12-Sep-2023 10:11:20",
      "created_date": "05-Oct-2019 23:10:55",
      "transaction_type": "award",
      "transaction_attributes": {
        "order_id": "758765",
        "coupon_code": "$5OFFVYZ",
        "reason": "purchase"
      },
      "id": "65003948ebeffa000ccc6bb7"
    }
  ],
  "more": false
}