Return Webhook

Return Webhook

This notification is sent when the Return topic is requested. For those that subscribe to this topic for more than one trigger event, the "trigger" property is included in the payload for reference.

The X-Loop-Signature is a base-64, HMAC hash of body payload using the Webhook Secret provided by Loop.

Note: Before attempting to create your hash of the POST request body, make sure slashes have been escaped & newlines have been removed from the JSON.

return

line_items

Line Item data reflects items being sent to Loop as part of the return.

Line items are provided in the return webhook in an array, if you need to know the quantity of items being returned you must iterate through the array and count the items.

Exchanges

Exchanges data reflects product(s) being sent to a customer. This can be a result of an even exchange, replacements for returned items, or new purchases made through the app.

Exchanges are provided in the return webhook in an array, if you need to know the quantity of items being exchanged you must iterate through the array and count the items.

carrier

refund

Amount of credit to be issued to the customer as a refund

return_method

If the return is not being sent back through boxing and shipping, this field describes the way in which the item is being returned. These are usually pick-up or drop-off options.

Response

{
  "topic": "return",
  "trigger": "return.updated",
  "id": "12345",
  "shop_id": "9876",
  "state": "open",
  "created_at": "2019-04-01T12:00:00+00:00",
  "edited_at": "2019-04-01T12:00:00+00:00", // can also be null
  "order_id": "1234567890",
  "order_name": "#1234",
  "provider_order_id": "1029384756",
  "order_number": "234",
  "customer": "[email protected]",
  "customer_detail": [
    "email": "[email protected]",
    "first_name": "Mary",
    "middle_name": "Todd",
    "last_name": "Lincoln",
  ],
  "currency": "USD",
  "return_product_total": "46.00",
  "return_discount_total": "0.00",
  "return_tax_total": "3.34",
  "return_total": "49.34",
  "return_credit_total": "49.34",
  "exchange_product_total": "84.00",
  "exchange_discount_total": "10.00",
  "exchange_tax_total": "5.37",
  "exchange_total": "79.37",
  "exchange_credit_total": "49.34",
  "gift_card": "0.00",
  "handling_fee": "0.00",
  "refund": "0.00",
  "refunds": [
    {
      "gateway": "your gateway",
      "amount": "0.00"
    }
  ],
  "upsell": "30.03",
  "address": {
    "name": "First Last",
    "company": "Company Name",
    "address1": "123 Road",
    "address2": "apt 1",
    "city": "Anywhere",
    "state": "California",
    "zip": "11111",
    "country": "United States",
    "country_code": "US",
    "phone": ""
  },
  "line_items": [
    {
      "line_item_id": "123456789",
      "provider_line_item_id": "3847568374653883",
      "product_id": "1624622563417",
      "variant_id": "14773475377241",
      "sku": "FD-RL-2",
      "barcode": "",
      "title": "Retro Laser - Big",
      "price": "46.00",
      "discount": "0.00",
      "tax": "3.34",
      "refund": "0.00",
      "returned_at": "2019-04-01T12:00:00+00:00",
      "exchange_variant": "",
      "return_reason": "Reason here",
      "parent_return_reason": "Parent reason here",
      "outcome": "Line item outcome('default', 'keep', 'donate', 'reject')"
    }
  ],
  "exchanges": [
    {
      "exchange_id": "54320",
      "product_id": "1624622563418",
      "variant_id": "14773475377242",
      "sku": "FD-NC-1",
      "exchange_order_name": "#1234",
      "exchange_order_id": "1234",
      "title": "Noisy Cricket - Small",
      "price": "46.00",
      "discount": "5.48",
      "tax": "2.94",
      "total": "43.46",
      "out_of_stock": true, // true | false
      "out_of_stock_resolution": "credited" // credited | refunded | null
    },
    {
      "exchange_id": "54321",
      "product_id": "1624622563419",
      "variant_id": "14773475377243",
      "sku": "FD-RG-2",
      "exchange_order_name": "12345-1",
      "exchange_order_id": "13131313",
      "title": "Ray Gun - Medium",
      "price": "46.00",
      "discount": "5.48",
      "tax": "2.94",
      "total": "43.46",
      "out_of_stock": false,
      "out_of_stock_resolution": null
    }
  ],
  "carrier": "USPS", // If no label exists, we pass "N/A"
  "tracking_number": "28735625627856237856287", // If no label exists, we pass "N/A"
  "label_status": "in_transit", // If no label exists, we pass "N/A"
  "label_updated_at": "2019-04-01T12:00:00+00:00", // If no label exists, we pass "N/A"
  "status_page_url": "https://partner.loopreturns.com/#/return/12345456",
  "destination_id": "2",
  "return_method": {  // If no return method exists, we pass null
    "provider": "happy-returns",
    "return_method_type": "drop-off",
    "address": {
      "name": "Staples 0152",
      "company": null,
      "address1": "7881 Edinger Ave.Ste.130",
      "address2": "Bella Terra Mall",
      "city": "Huntington Beach",
      "state": "CA",
      "zip": "92647",
      "country": "United States of America",
      "country_code": "US",
      "phone": "",
      "latitude": 33.7313927,
      "longitude": -117.9910687
    },
    "state": "new",
    "rma_id": "HRABC123",
    "qr_code_url": "https://partner.happyreturns.com/barcode/qr?code=HRABC123",
    "scheduled_at": null
  },
  "shipment_id": "fwe66545646"
}