This is Documentation for the V1 API

V2 API docmentation is located at docs.getwhiplash.com/api

Web Hooks

Web Hooks allow Whiplash to notify your application(s) when something happens on our end, like an order shipping or an item's inventory changing. You tell us where you want the notification to go (the URL), and we send you the goods.

Web Hooks go out via POST requests as either JSON or XML. Typically, a notification will look just like the results of an API call, i.e. order.shipped will send you a detail of the order, and item.inventory_changed will send you a detail of the item. Each Web Hook will also include the event_name, so your app knows what type of information to expect and/or you can use the same endpoint for multiple Whiplash events.

NOTE: XML requests are wrapped in a web-hook root node.

You can create as many destinations for each event as you like (so you can notify multiple apps/services, for instance).

Web Hooks are editable on your preferences page.

Additionally, you can create, list, and delete web hooks via The Whiplash API.

Please note that a properly received web hook should always return a 2XX/success response.

For each event, a web hook will make 10 attempts. For any given event (i.e. order.shipped), the web hook will be deactivated after 100 consecutive failures. Deactivated web hooks may be reactivated any time on your preferences page.

Verifying Web Hooks

You can verify that a web hook is really coming from Whiplash by checking its signature. We send web hooks with an X-WHIPLASH-SIGNATURE header. This can be checked by computing an HMAC digest using sing the SHA256 hash algorithm, your API Key, and the web hook's request body.

For example:

require 'openssl'
require 'base64'

sha256 = OpenSSL::Digest::SHA256.new
api_key = {customer.api_key}
body = request.body.read
signature = OpenSSL::HMAC.hexdigest(sha256, api_key, body)
    
$api_key = {customer.api_key};
$body = file_get_contents('php://input');
$signature = hash_hmac('sha256', $body, $api_key);
    
var crypto = require('crypto');
var hmac = crypto.createHmac('sha256', {customer.api_key});
hmac.update(responseBody);
var signature = hmac.digest().toString('hex');
    

order.shipped

Order Shipped

{
  "event_name": "order.shipped",
  "order": {
    "id": 1234567,
    "billed": false,
    "created_at": "2015-03-11T07:50:33Z",
    "days_in_transit": 1,
    "days_in_transit_carrier_estimate": 1,
    "email": "whiplash@whiplashmerch.com",
    "gift": false,
    "originator_notified": true,
    "shop_shipping_method_price": 8.85,
    "shop_shipping_method_text": "USPS Priority Mail 2-Day",
    "shop_shipping_method_currency": "USD",
    "shop_warehouse_ids": [
      1
    ],
    "shop_created_at": "2015-03-11T07:50:33Z",
    "shop_updated_at": "2015-03-11T07:50:33Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22Z",
    "shipping_address_1": "1334 San Mateo Avenue",
    "shipping_address_2": "",
    "shipping_city": "South San Francisco",
    "shipping_company": null,
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_name": "James Hetfield",
    "shipping_phone": "1231234567",
    "shipping_state": "CA",
    "shipping_zip": 94080,
    "status": 300,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27Z",
    "tracking": [
      "911111111111111111111"
    ],
    "tracking_links": [
      "http://www.usps/com/tracking/911111111111111111111"
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": null,
    "proto_originator_id": "5623643082",
    "provider": "example_provider",
    "insure": false,
    "require_signature": false,
    "saturday_delivery": false,
    "insurance_value": 100.18,
    "level1_token": "13PKVSFLIW69r97782",
    "level2_token": "2DHFIP56Y2PKa97782",
    "public_note": null,
    "warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Shipped",
    "customer_id": 1234,
    "skip_address_verification": false,
    "currency": "USD",
    "batched": false,
    "reference": "54321",
    "req_ship_method_price": "0.0",
    "req_ship_method_text": null,
    "return_address_1": null,
    "return_address_2": null,
    "return_approved_token": "CEFG5436VG678",
    "return_city": null,
    "return_company": null,
    "return_name": null,
    "return_country": null,
    "return_email": null,
    "return_phone": null,
    "return_state": null,
    "return_zip": null,
    "ship_3rdparty_zip": null,
    "ship_3rdparty_country": null,
    "ship_3rdparty_account": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 70.0,
        "retail_fee": null,
        "wholesale_cost": null,
        "currency": "USD",
        "quantity": 1,
        "sku": "TI-LP",
        "description": "Test Item LP",
        "available": true,
        "returnable": null,
        "originator_id": "76543",
        "provider": "example_provider",
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T07:50:34Z",
        "serialnumbers": [
          111222333
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 49.5,
        "retail_fee": null,
        "wholesale_cost": null,
        "currency": "USD",
        "quantity": 1,
        "sku": "TI-Shirt-S",
        "description": "Test Item T-Shirt, Small",
        "available": true,
        "returnable": null,
        "originator_id": "76522",
        "provider": "example_provider",
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T13:48:59Z",
        "serialnumbers": [
          22223333444
        ]
      }
    ]
  }
}
    

item.inventory_changed

Item Inventory Changed

{
  "event_name": "item.inventory_changed",
  "item": {
    "available": true,
    "created_at": "2015-03-06T20:31:34Z",
    "description": "XXL",
    "height": 0.2,
    "id": 12345,
    "image_file_name": null,
    "image_originator_url": null,
    "image_updated_at": null,
    "is_bundle": false,
    "length": 25.0,
    "media_mail": false,
    "packaging": false,
    "price": 22.0,
    "quantity": 2,
    "sku": "TI-Shirt-XXL",
    "street_date": null,
    "title": "Test Item T-Shirt",
    "updated_at": "2015-03-06T22:14:51Z",
    "vendor": "Example Vending",
    "weight": 0.5,
    "wholesale_cost": 15.0,
    "width": 15.0,
    "tariff_number": "0406.20.90.20",
    "originators": [
      {
        "group_id": "98754",
        "original_id": "76543",
        "provider": "example_provider"
      }
    ]
  },
  "transaction": {
    "change": 1,
    "created_at": "2014-09-16T05:02:18Z",
    "description": "Returned to stock from Order 12344, + 1",
    "item_id": 1234,
    "order_id": 2345,
    "quantity": 489,
    "shipnotice_id": null,
    "updated_at": "2014-09-16T05:02:18Z"
  },
  "warehouse_quantities": [
    {
      "id": 1,
      "name": "Ann Arbor",
      "email": "annarbor@whiplashmerch.com",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": null,
      "shipping_city": "Ann Arbor",
      "shipping_country": "US",
      "shipping_country_iso2": "US",
      "shipping_state": "Michigan",
      "shipping_zip": 48108,
      "quantity": 17
    },
    {
      "id": 2,
      "name": "San Francisco",
      "email": "sanfrancisco@whiplashmerch.com",
      "shipping_address_1": "1334 San Mateo Avenue",
      "shipping_address_2": null,
      "shipping_city": "South San Francisco",
      "shipping_country": "US",
      "shipping_country_iso2": "US",
      "shipping_state": "California",
      "shipping_zip": 94080,
      "quantity": 99
    }
  ]
}
    

shipnotice.created

Ship Notice Created

{
  "event_name": "shipnotice.created",
  "shipnotice": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11Z",
    "id": 1211,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "received_by": 123,
    "sender": "Your Company",
    "status": 100,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "Completed",
    "shipnotice_items": [
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33Z",
        "description": null,
        "extended_description": null,
        "fee": null,
        "height": 1,
        "id": 1234,
        "item_id": 12345,
        "length": 13,
        "quantity": 10,
        "quantity_damaged": 0,
        "quantity_good": 10,
        "shipnotice_id": 17211,
        "updated_at": "2015-03-01T07:50:33Z",
        "weight": 7.6,
        "width": 12
      },
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33Z",
        "description": null,
        "extended_description": null,
        "fee": null,
        "height": 1,
        "id": 1235,
        "item_id": 12346,
        "length": 11,
        "quantity": 15,
        "quantity_damaged": 0,
        "quantity_good": 15,
        "shipnotice_id": 17211,
        "updated_at": "2015-03-01T07:50:33Z",
        "weight": 7.4,
        "width": 12
      }
    ],
    "shipnotice_images": null
  }
}
    

shipnotice.status_changed

Ship Notice Status Changed

{
  "event_name": "shipnotice.status_changed",
  "shipnotice": {
    "arrived_at": "2015-03-11T13:50:27Z",
    "completed_at": "2015-03-12T09:30:17Z",
    "eta": "2015-03-14T16:10:11Z",
    "id": 1234,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "received_by": 123,
    "sender": "Your Company",
    "status": 300,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "Completed",
    "shipnotice_items": [
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33Z",
        "description": null,
        "extended_description": null,
        "fee": null,
        "height": 1,
        "id": 1234,
        "item_id": 12345,
        "length": 13,
        "quantity": 10,
        "quantity_damaged": 0,
        "quantity_good": 10,
        "shipnotice_id": 17211,
        "updated_at": "2015-03-01T07:50:33Z",
        "weight": 7.6,
        "width": 12
      },
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33Z",
        "description": null,
        "extended_description": null,
        "fee": null,
        "height": 1,
        "id": 1235,
        "item_id": 12346,
        "length": 11,
        "quantity": 15,
        "quantity_damaged": 0,
        "quantity_good": 15,
        "shipnotice_id": 17211,
        "updated_at": "2015-03-01T07:50:33Z",
        "weight": 7.4,
        "width": 12
      }
    ],
    "shipnotice_images": null
  }
}
    

consumer_return.created

Consumer Return Created

{
  "event_name": "consumer_return.created",
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11Z",
    "id": 1211,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": 123,
    "sender": "Your Company",
    "status": 100,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "ship_method": "USPS Priority",
    "shipping_label_url": "http://assets.geteasypost.com/postage_labels/labels/xxx123.png",
    "total_boxes": 1,
    "total_fee_actual": 7.83,
    "warehouse_id": 2,
    "status_name": "in transit",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11Z",
      "days_in_transit": 1,
      "email": "example@address.com",
      "gift": false,
      "id": 112233,
      "insure": false,
      "originator_notified": false,
      "pack_fee_actual": null,
      "packaging_fee_actual": null,
      "pick_fee_actual": null,
      "public_note": null,
      "require_signature": false,
      "level2_token": "xxxyyyzzz12312312344",
      "level1_token": "xxxyyyzzz12312312344",
      "ship_3rdparty_cost": 0.0,
      "ship_actual_cost": null,
      "ship_notes": null,
      "shipped_on": null,
      "shipping_address_1": "123 some street",
      "shipping_address_2": null,
      "shipping_city": "beverly hills",
      "shipping_company": null,
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "shipping_name": "Example Customer",
      "shipping_phone": 1231231234,
      "shipping_state": "CA",
      "shipping_zip": 90210,
      "shop_shipping_method_price": 0.0,
      "shop_shipping_method_text": null,
      "status": 75,
      "total_fee_actual": null,
      "tracking_sent": false,
      "updated_at": "2015-03-14T16:10:11Z",
      "warehouse_id": null,
      "tracking": [

      ],
      "originator_id": 123123,
      "provider": "whiplash:replace",
      "monetary_value": 88.0,
      "insurance_value": 88.0,
      "ship_method": "USPS Priority Mail",
      "status_name": "Pending Return",
      "order_items": [
        {
          "available": true,
          "created_at": "2015-03-14T16:10:11Z",
          "description": "Example Item - Size L",
          "id": 111222333,
          "item_id": 1235,
          "order_id": 112233,
          "package_id": 123,
          "packaging": false,
          "packed": 0,
          "price": 88.0,
          "quantity": 1,
          "returnable": null,
          "sku": "123-xxx-123",
          "updated_at": "2015-03-14T16:10:11Z",
          "originator_id": "order_478615-item_272897",
          "provider": "whiplash:replace",
          "serialnumbers": [

          ]
        }
      ],
      "packages": [

      ]
    },
    "return_items": [
      {
        "price": 63.0,
        "name": "Example Item - Size M",
        "sku": "EI-M",
        "description": "Other",
        "extended_description": null,
        "return_action": "exchange",
        "item_id": 1234,
        "order_item_id": 1122,
        "originator_id": 112233,
        "weight": 8.9,
        "length": 1.0,
        "width": 14.0,
        "height": 1.0,
        "quantity": 1
      },
      {
        "price": 22.0,
        "name": "Example Album - LP",
        "sku": "EA-LP",
        "description": null,
        "extended_description": null,
        "return_action": "refund",
        "item_id": 1233,
        "order_item_id": 1123,
        "originator_id": 112234,
        "weight": 3.9,
        "length": 12.0,
        "width": 12.0,
        "height": 0.25,
        "quantity": 1
      },
      {
        "price": 32.0,
        "name": "Example Thingy",
        "sku": "ET",
        "description": null,
        "extended_description": null,
        "return_action": "credit",
        "item_id": 1111,
        "order_item_id": 1124,
        "originator_id": 112235,
        "weight": 13.9,
        "length": 22.0,
        "width": 2.0,
        "height": 0.25,
        "quantity": 1
      }
    ]
  }
}
    

consumer_return.deleted

Consumer Return Deleted

{
  "event_name": "consumer_return.deleted",
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11Z",
    "id": 1211,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": 123,
    "sender": "Your Company",
    "status": 100,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "ship_method": "USPS Priority",
    "shipping_label_url": "http://assets.geteasypost.com/postage_labels/labels/xxx123.png",
    "total_boxes": 1,
    "total_fee_actual": 7.83,
    "warehouse_id": 2,
    "status_name": "in transit",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11Z",
      "days_in_transit": 1,
      "email": "example@address.com",
      "gift": false,
      "id": 112233,
      "insure": false,
      "originator_notified": false,
      "pack_fee_actual": null,
      "packaging_fee_actual": null,
      "pick_fee_actual": null,
      "public_note": null,
      "require_signature": false,
      "level2_token": "xxxyyyzzz123123123",
      "level1_token": "xxxyyyzzz123123123",
      "ship_3rdparty_cost": 0.0,
      "ship_actual_cost": null,
      "ship_notes": null,
      "shipped_on": null,
      "shipping_address_1": "123 some street",
      "shipping_address_2": null,
      "shipping_city": "beverly hills",
      "shipping_company": null,
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "shipping_name": "Example Customer",
      "shipping_phone": 1231231234,
      "shipping_state": "CA",
      "shipping_zip": 90210,
      "shop_shipping_method_price": 0.0,
      "shop_shipping_method_text": null,
      "status": 75,
      "total_fee_actual": null,
      "tracking_sent": false,
      "updated_at": "2015-03-14T16:10:11Z",
      "warehouse_id": null,
      "tracking": [

      ],
      "originator_id": 123123,
      "provider": "whiplash:replace",
      "monetary_value": 88.0,
      "insurance_value": 88.0,
      "ship_method": "USPS Priority Mail",
      "status_name": "Pending Return",
      "order_items": [
        {
          "available": true,
          "created_at": "2015-03-14T16:10:11Z",
          "description": "Example Item - Size L",
          "id": 111222333,
          "item_id": 1235,
          "order_id": 112233,
          "package_id": 123,
          "packaging": false,
          "packed": 0,
          "price": 88.0,
          "quantity": 1,
          "returnable": null,
          "sku": "123-xxx-123",
          "updated_at": "2015-03-14T16:10:11Z",
          "originator_id": "order_478615-item_272897",
          "provider": "whiplash:replace",
          "serialnumbers": [

          ]
        }
      ],
      "packages": [

      ]
    },
    "return_items": [
      {
        "price": 63.0,
        "name": "Example Item - Size M",
        "sku": "EI-M",
        "description": "Other",
        "extended_description": null,
        "return_action": "exchange",
        "item_id": 1234,
        "order_item_id": 1122,
        "originator_id": 112233,
        "weight": 8.9,
        "length": 1.0,
        "width": 14.0,
        "height": 1.0,
        "quantity": 1
      },
      {
        "price": 22.0,
        "name": "Example Album - LP",
        "sku": "EA-LP",
        "description": null,
        "extended_description": null,
        "return_action": "refund",
        "item_id": 1233,
        "order_item_id": 1123,
        "originator_id": 112234,
        "weight": 3.9,
        "length": 12.0,
        "width": 12.0,
        "height": 0.25,
        "quantity": 1
      },
      {
        "price": 32.0,
        "name": "Example Thingy",
        "sku": "ET",
        "description": null,
        "extended_description": null,
        "return_action": "credit",
        "item_id": 1111,
        "order_item_id": 1124,
        "originator_id": 112235,
        "weight": 13.9,
        "length": 22.0,
        "width": 2.0,
        "height": 0.25,
        "quantity": 1
      }
    ]
  }
}
    

order.delivered

Order Delivered

{
  "event_name": "order.delivered",
  "order": {
    "id": 1234567,
    "billed": false,
    "created_at": "2015-03-11T07:50:33Z",
    "days_in_transit": 1,
    "days_in_transit_carrier_estimate": 1,
    "email": "whiplash@whiplashmerch.com",
    "gift": false,
    "originator_notified": true,
    "shop_shipping_method_price": 8.85,
    "shop_shipping_method_text": "USPS Priority Mail 2-Day",
    "shop_shipping_method_currency": "USD",
    "shop_warehouse_ids": [
      1
    ],
    "shop_created_at": "2015-03-11T07:50:33Z",
    "shop_updated_at": "2015-03-11T07:50:33Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22Z",
    "shipping_address_1": "1334 San Mateo Avenue",
    "shipping_address_2": "",
    "shipping_city": "South San Francisco",
    "shipping_company": null,
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_name": "James Hetfield",
    "shipping_phone": "1231234567",
    "shipping_state": "CA",
    "shipping_zip": 94080,
    "status": 300,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27Z",
    "tracking": [
      "911111111111111111111"
    ],
    "tracking_links": [
      "http://www.usps/com/tracking/911111111111111111111"
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": null,
    "proto_originator_id": "5623643082",
    "provider": "example_provider",
    "insure": false,
    "require_signature": false,
    "saturday_delivery": false,
    "insurance_value": 100.18,
    "level1_token": "13PKVSFLIW69r97782",
    "level2_token": "2DHFIP56Y2PKa97782",
    "public_note": null,
    "warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Shipped",
    "customer_id": 1234,
    "skip_address_verification": false,
    "currency": "USD",
    "batched": false,
    "reference": "54321",
    "req_ship_method_price": "0.0",
    "req_ship_method_text": null,
    "return_address_1": null,
    "return_address_2": null,
    "return_approved_token": "CEFG5436VG678",
    "return_city": null,
    "return_company": null,
    "return_name": null,
    "return_country": null,
    "return_email": null,
    "return_phone": null,
    "return_state": null,
    "return_zip": null,
    "ship_3rdparty_zip": null,
    "ship_3rdparty_country": null,
    "ship_3rdparty_account": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 70.0,
        "retail_fee": null,
        "wholesale_cost": null,
        "currency": "USD",
        "quantity": 1,
        "sku": "TI-LP",
        "description": "Test Item LP",
        "available": true,
        "returnable": null,
        "originator_id": "76543",
        "provider": "example_provider",
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T07:50:34Z",
        "serialnumbers": [
          111222333
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 49.5,
        "retail_fee": null,
        "wholesale_cost": null,
        "currency": "USD",
        "quantity": 1,
        "sku": "TI-Shirt-S",
        "description": "Test Item T-Shirt, Small",
        "available": true,
        "returnable": null,
        "originator_id": "76522",
        "provider": "example_provider",
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T13:48:59Z",
        "serialnumbers": [
          22223333444
        ]
      }
    ]
  },
  "tracking_details": [
    {
      "created_at": "2015-03-14T13:50:27Z",
      "description": "THE RECEIVER WAS NOT AVAILABLE AT THE TIME OF THE FIRST DELIVERY ATTEMPT. A SECOND ATTEMPT WILL BE MADE.",
      "status": "in_transit"
    },
    {
      "created_at": "2015-03-15T13:50:27Z",
      "description": "Delivered, In/At Mailbox in TACOMA, WA",
      "status": "delivered"
    }
  ]
}
    

consumer_return.status_changed

Consumer Return Status Change

{
  "event_name": "consumer_return.status_changed",
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11Z",
    "id": 1211,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": 123,
    "sender": "Your Company",
    "status": 300,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "ship_method": "USPS Priority",
    "shipping_label_url": "http://assets.geteasypost.com/postage_labels/labels/xxx123.png",
    "total_boxes": 1,
    "total_fee_actual": 7.83,
    "warehouse_id": 2,
    "status_name": "in transit",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11Z",
      "days_in_transit": 1,
      "email": "example@address.com",
      "gift": false,
      "id": 112233,
      "insure": false,
      "originator_notified": false,
      "pack_fee_actual": null,
      "packaging_fee_actual": null,
      "pick_fee_actual": null,
      "public_note": null,
      "require_signature": false,
      "level2_token": "xxxyyyzzz12312312344",
      "level1_token": "xxxyyyzzz12312312344",
      "ship_3rdparty_cost": 0.0,
      "ship_actual_cost": null,
      "ship_notes": null,
      "shipped_on": null,
      "shipping_address_1": "123 some street",
      "shipping_address_2": null,
      "shipping_city": "beverly hills",
      "shipping_company": null,
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "shipping_name": "Example Customer",
      "shipping_phone": 1231231234,
      "shipping_state": "CA",
      "shipping_zip": 90210,
      "shop_shipping_method_price": 0.0,
      "shop_shipping_method_text": null,
      "status": 75,
      "total_fee_actual": null,
      "tracking_sent": false,
      "updated_at": "2015-03-14T16:10:11Z",
      "warehouse_id": null,
      "tracking": [

      ],
      "originator_id": 123123,
      "provider": "whiplash:replace",
      "monetary_value": 88.0,
      "insurance_value": 88.0,
      "ship_method": "USPS Priority Mail",
      "status_name": "Pending Return",
      "order_items": [
        {
          "available": true,
          "created_at": "2015-03-14T16:10:11Z",
          "description": "Example Item - Size L",
          "id": 111222333,
          "item_id": 1235,
          "order_id": 112233,
          "package_id": 123,
          "packaging": false,
          "packed": 0,
          "price": 88.0,
          "quantity": 1,
          "returnable": null,
          "sku": "123-xxx-123",
          "updated_at": "2015-03-14T16:10:11Z",
          "originator_id": "order_478615-item_272897",
          "provider": "whiplash:replace",
          "serialnumbers": [

          ]
        }
      ],
      "packages": [

      ]
    },
    "return_items": [
      {
        "price": 63.0,
        "name": "Example Item - Size M",
        "sku": "EI-M",
        "description": "Other",
        "extended_description": null,
        "return_action": "exchange",
        "item_id": 1234,
        "order_item_id": 1122,
        "originator_id": 112233,
        "weight": 8.9,
        "length": 1.0,
        "width": 14.0,
        "height": 1.0,
        "quantity": 1
      },
      {
        "price": 22.0,
        "name": "Example Album - LP",
        "sku": "EA-LP",
        "description": null,
        "extended_description": null,
        "return_action": "refund",
        "item_id": 1233,
        "order_item_id": 1123,
        "originator_id": 112234,
        "weight": 3.9,
        "length": 12.0,
        "width": 12.0,
        "height": 0.25,
        "quantity": 1
      },
      {
        "price": 32.0,
        "name": "Example Thingy",
        "sku": "ET",
        "description": null,
        "extended_description": null,
        "return_action": "credit",
        "item_id": 1111,
        "order_item_id": 1124,
        "originator_id": 112235,
        "weight": 13.9,
        "length": 22.0,
        "width": 2.0,
        "height": 0.25,
        "quantity": 1
      }
    ]
  }
}
    

consumer_return.completed

Consumer Return Completed

{
  "event_name": "consumer_return.completed",
  "consumer_return": null
}