Sign in

v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

post/transactions/return

Request body

member_idstring required

Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in Zinrelo.

transaction_attributesstring json
<p style="color: #252525;">In order to return points for "made_a_purchase" activity, the mandatory field is <strong style="color: #252525;">order_id</strong>. With this, you can also pass <strong style="color: #252525;">returned_product_id and returned_product_quantity</strong> together or just <strong style="color: #252525;">returned_amount.</strong> </p> <p style="color: #252525;"><strong>Note:</strong> If you just pass "order_id," the amount will be fully returned.</p> <p><strong> We are also accepting product quantities in decimal values.</p></strong> <p>For example:</p> <p><code class="c-mrkdwn__code" data-stringify-type="code">{</code></p> <p><code class="c-mrkdwn__code" data-stringify-type="code">"tags" : ["ProductReturn"],</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"reason" : "Order partially returned",</code><code class="c-mrkdwn__code" data-stringify-type="code"></code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"order_id" : "56789", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"returned_amount" : "200" </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">}</code></p> <p><code class="c-mrkdwn__code" data-stringify-type="code">or</code></p> <p><code class="c-mrkdwn__code" data-stringify-type="code">{</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"order_id" : "56789", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"returned_product_id" : "1235BCDI", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"returned_product_quantity" : 2</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">}</code></p>

Example request

{
  "member_id": "john.doe@gmail.com"
}

Response

200

successboolean

Example response

{
  "data": {
    "status": "approved",
    "transaction_attributes": {
      "tags": [
        "productreturned",
        "returned"
      ],
      "order_id": "7597659870",
      "reason": "Order partially returned",
      "returned_amount": 200
    },
    "last_modified_date": "22-Mar-2023 06:14:15",
    "additional_data": {
      "returned_orders_revenue": 200,
      "quantity": 1
    },
    "approver_details": {
      "approver_name": "System"
    },
    "approved_date": "22-Mar-2023 06:14:15",
    "member_id": "5779678689",
    "created_date": "22-Mar-2023 06:14:15",
    "transaction_type": "deduct",
    "id": "641a9cb7c2161f000c2eb553",
    "deduct_info": {
      "points": 200,
      "points_status": "deducted",
      "unable_to_deduct": 0
    }
  },
  "success": true
}