Sign in

v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

Modify a pending Award Transaction using Unique Transaction Attribute

post/transactions/{unique_transaction_attribute}

Request body

transaction_attributesstring json
<p>Every award activity can be modified using this API. You can change the custom attributes for each activity as well as the predefined attributes.</p> <p><strong>Let's take the example of made_a_purchase activity:</strong></p> <p>Mandatory attributes are order_total and order_subtotal.</p> <p>A sample structure of the transaction_attributes for the made_a_purchase activity is given below:</p> <p><code class="c-mrkdwn__code" data-stringify-type="code">{</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"tags" : ["tag1","tag2"], </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"reason" : "purchase",</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"coupons" : "$5OFFVYZ",</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"order_total" : "1000",</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"order_subtotal" : "1000",</code></p> <p><code class="c-mrkdwn__code" data-stringify-type="code">"products" : [{</code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_id": "112", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_quantity": "1", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_category": "tshirt", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_price": "15", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_title": "Sweatshirt", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_image_url": "" </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> },</code></p> <p><code class="c-mrkdwn__code" data-stringify-type="code">{</code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_id": "980", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_quantity": "2", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_category": "Sales", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_price": "10.017", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_title": "Pant", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code"> "product_image_url": ""</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">}]</code></p> <p><code class="c-mrkdwn__code" data-stringify-type="code">}</code></p> <p><strong>Note:</strong> You cannot modify the upload_a_photo, submit_a_receipt and code_submission activities.<code class="c-mrkdwn__code" data-stringify-type="code"></code></p> <p>We are also accepting product quantities in decimal values.</p>
approval_datestring

Example request

{
  "approval_date": "10/15/2019 16:10:00"
}

Response

200

successboolean

Example response

{
  "data": {
    "status": "pending",
    "points_expiration_date": "22-Mar-2026 09:21:18",
    "auto_approval_date": "23-Oct-2023 16:10:00",
    "last_modified_date": "22-Mar-2023 09:21:19",
    "award_info": {
      "activity_id": "made_a_purchase",
      "points": 1000,
      "points_status": "pending",
      "activity_name": "Purchase on website"
    },
    "id": "641ac88fc2161f000b21ff5e",
    "approver_details": {
      "approver_name": "System"
    },
    "approved_date": "",
    "member_id": "5779678689",
    "created_date": "22-Mar-2023 09:21:18",
    "transaction_type": "award",
    "transaction_attributes": {
      "order_total": 1000,
      "products": [
        {
          "product_id": "112",
          "is_excluded": false,
          "product_category": "tshirt",
          "product_url": "www.zinrelo.com/sweatshirts",
          "product_price": "15",
          "product_points_per_quantity": 15,
          "bonus_multiplier": 0,
          "product_quantity": "1",
          "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252",
          "product_title": "Sweatshirt"
        },
        {
          "product_id": "980",
          "is_excluded": false,
          "product_category": "Sales",
          "product_url": "www.zinrelo.com/pant",
          "product_price": "10.017",
          "product_points_per_quantity": 10,
          "bonus_multiplier": 0,
          "product_quantity": "2",
          "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252",
          "product_title": "Pant"
        }
      ],
      "coupon_code": "$5OFFVYZ",
      "order_id": "7590984210",
      "tags": [
        "productpurchased",
        "transactioninpendingstatus"
      ],
      "currency": "dollars",
      "reason": "purchase",
      "favourite_cuisine": "indian",
      "product_list": [
        "pants",
        "t-shirt",
        "trousers"
      ],
      "gender": "Male",
      "favourite_destination": "London",
      "order_subtotal": 1000,
      "coupons": "$5OFFVYZ"
    },
    "additional_data": {
      "activity_multiplier": 1
    }
  },
  "success": true
}