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 JSON. 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.

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 Notifications 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.

Events

We currently suport notifications for the following events:

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');
    

consumer_return.completed

Sent when a return is marked as completed.

{
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "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,
    "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": "Complete",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "exchange_order_id": 112233,
    "shipping_method_id": 5,
    "tracking": null,
    "originator_id": 3434,
    "group_id": 5533,
    "url": null,
    "meta_data": "{}",
    "reference": null,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11.000Z",
      "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:11.000Z",
      "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:11.000Z",
          "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:11.000Z",
          "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
      }
    ]
  },
  "event_name": "consumer_return.completed"
}
    

consumer_return.created

Sent when a return is created.

{
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": null,
    "sender": "Your Company",
    "status": 50,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "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": "Draft",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "exchange_order_id": 112233,
    "shipping_method_id": 5,
    "tracking": null,
    "originator_id": 3434,
    "group_id": 5533,
    "url": null,
    "meta_data": "{}",
    "reference": null,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11.000Z",
      "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:11.000Z",
      "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:11.000Z",
          "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:11.000Z",
          "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
      }
    ]
  },
  "event_name": "consumer_return.created"
}
    

consumer_return.deleted

Sent when a return is deleted.

{
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": null,
    "sender": "Your Company",
    "status": 50,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "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": "Draft",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "exchange_order_id": 112233,
    "shipping_method_id": 5,
    "tracking": null,
    "originator_id": 3434,
    "group_id": 5533,
    "url": null,
    "meta_data": "{}",
    "reference": null,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11.000Z",
      "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:11.000Z",
      "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:11.000Z",
          "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:11.000Z",
          "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
      }
    ]
  },
  "event_name": "consumer_return.deleted"
}
    

consumer_return.status_changed

Sent when the status of a return is changed.

{
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": null,
    "sender": "Your Company",
    "status": 100,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "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,
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "exchange_order_id": 112233,
    "shipping_method_id": 5,
    "tracking": null,
    "originator_id": 3434,
    "group_id": 5533,
    "url": null,
    "meta_data": "{}",
    "reference": null,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11.000Z",
      "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:11.000Z",
      "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:11.000Z",
          "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:11.000Z",
          "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
      }
    ]
  },
  "event_name": "consumer_return.status_changed"
}
    

consumer_return.unexpected

Sent when Whiplash receives a return without an RMA.

{
  "consumer_return": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "order_id": 1234,
    "order_originator_id": 4321,
    "pack_fee_actual": 2.51,
    "pick_fee_actual": null,
    "received_by": null,
    "sender": "Your Company",
    "status": 25,
    "ship_3rdparty_cost": null,
    "ship_actual_cost": 5.32,
    "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": "Unexpected",
    "return_value": 117.0,
    "refund_value": 22.0,
    "exchange_value": 63.0,
    "credit_value": 32.0,
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "exchange_order_id": 112233,
    "shipping_method_id": 5,
    "tracking": null,
    "originator_id": 3434,
    "group_id": 5533,
    "url": null,
    "meta_data": "{}",
    "reference": null,
    "exchange_order": {
      "billed": false,
      "created_at": "2015-03-14T16:10:11.000Z",
      "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:11.000Z",
      "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:11.000Z",
          "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:11.000Z",
          "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
      }
    ]
  },
  "event_name": "consumer_return.unexpected"
}
    

customer.card_declined

Sent when we have trouble billing the credit card on file.

{
  "customer": {
    "auto_merge_gestation": null,
    "billing_address1": null,
    "billing_address2": null,
    "billing_address3": null,
    "billing_city": null,
    "billing_company": null,
    "billing_contact_name": null,
    "billing_country": "US",
    "billing_phone1": null,
    "billing_phone2": null,
    "billing_state": null,
    "default_warehouse_id": 1,
    "eori_number": null,
    "id": 123,
    "incoterm": "DDU",
    "items_exchangeable": true,
    "name": "1979",
    "return_address_1": null,
    "return_address_2": null,
    "return_city": null,
    "return_company": null,
    "return_country": null,
    "return_email": null,
    "return_label_expires_in": 29,
    "return_name": null,
    "return_phone": null,
    "return_state": null,
    "return_zip": null,
    "shipping_name": "Your Company",
    "supports_return_labels": true,
    "vat_number": null,
    "ein": "123xxx456",
    "full_logo_url": "",
    "replenishment_min": 0,
    "replenishment_target": 0
  },
  "event_name": "customer.card_declined"
}
    

invoice.created

Sent when there is a new invoice ready for your account.

{
  "invoice": {
    "account_id": 4517,
    "balance_forward_amount": null,
    "billing_period_end": "2017-07-01T03:59:59.000Z",
    "billing_period_start": "2017-06-01T04:00:00.000Z",
    "created_at": "2017-07-01T17:22:58.000Z",
    "csv_url": null,
    "grand_total": 0.0,
    "id": 42670,
    "paid_in_full": false,
    "paid_total": 0.0,
    "pdf_url": null,
    "updated_at": "2017-07-01T17:22:58.000Z"
  },
  "event_name": "invoice.created"
}
    

item.created

Sent when an item has been created.

{
  "item": {
    "available": true,
    "created_at": "2015-03-06T20:31:34.000Z",
    "description": "XXL",
    "height": 0.2,
    "id": 12345,
    "customer_id": 4532,
    "image_file_name": null,
    "image_originator_url": null,
    "image_updated_at": null,
    "is_bundle": false,
    "length": 25.0,
    "media_mail": false,
    "lot_control": false,
    "packaging": false,
    "price": 22.0,
    "quantity": 2,
    "published_quantity": 2,
    "sku": "TI-Shirt-XXL",
    "scancode": "GSJ-220097",
    "currency": "USD",
    "street_date": null,
    "title": "Test Item T-Shirt",
    "updated_at": "2015-03-06T22:14:51.000Z",
    "vendor": "Example Vending",
    "weight": 0.5,
    "wholesale_cost": 15.0,
    "width": 15.0,
    "tariff_number": "0406.20.90.20",
    "hazmat": false,
    "alcohol": false,
    "misc": null,
    "notify_originator_inventory": true,
    "returnable": true,
    "category": null,
    "ean": "nill",
    "contains_small_batteries": false,
    "packaging_type": "Box",
    "replenishment_min": 0,
    "replenishment_target": 0,
    "velocity": 0,
    "origin_country": null,
    "originators": [
      {
        "group_id": "98754",
        "original_id": "76543",
        "provider": "example_provider"
      }
    ]
  },
  "event_name": "item.created"
}
    

item.inventory_changed

Sent when the inventory for an item has changed.

{
  "item": {
    "available": true,
    "created_at": "2015-03-06T20:31:34.000Z",
    "description": "XXL",
    "height": 0.2,
    "id": 12345,
    "customer_id": 4532,
    "image_file_name": null,
    "image_originator_url": null,
    "image_updated_at": null,
    "is_bundle": false,
    "length": 25.0,
    "media_mail": false,
    "lot_control": false,
    "packaging": false,
    "price": 22.0,
    "quantity": 2,
    "published_quantity": 2,
    "sku": "TI-Shirt-XXL",
    "scancode": "GSJ-220097",
    "currency": "USD",
    "street_date": null,
    "title": "Test Item T-Shirt",
    "updated_at": "2015-03-06T22:14:51.000Z",
    "vendor": "Example Vending",
    "weight": 0.5,
    "wholesale_cost": 15.0,
    "width": 15.0,
    "tariff_number": "0406.20.90.20",
    "hazmat": false,
    "alcohol": false,
    "misc": null,
    "notify_originator_inventory": true,
    "returnable": true,
    "category": null,
    "ean": "nill",
    "contains_small_batteries": false,
    "packaging_type": "Box",
    "replenishment_min": 0,
    "replenishment_target": 0,
    "velocity": 0,
    "origin_country": null,
    "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": 12345,
    "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
    }
  ],
  "event_name": "item.inventory_changed"
}
    

item.low_inventory

Sent when the inventory for items have fallen below the specified low inventory threshold

{
  "items": [
    {
      "item": {
        "available": true,
        "created_at": "2015-03-06T20:31:34.000Z",
        "description": "XXL",
        "height": 0.2,
        "id": 12345,
        "customer_id": 4532,
        "image_file_name": null,
        "image_originator_url": null,
        "image_updated_at": null,
        "is_bundle": false,
        "length": 25.0,
        "media_mail": false,
        "lot_control": false,
        "packaging": false,
        "price": 22.0,
        "quantity": 2,
        "published_quantity": 2,
        "sku": "TI-Shirt-XXL",
        "scancode": "GSJ-220097",
        "currency": "USD",
        "street_date": null,
        "title": "Test Item T-Shirt",
        "updated_at": "2015-03-06T22:14:51.000Z",
        "vendor": "Example Vending",
        "weight": 0.5,
        "wholesale_cost": 15.0,
        "width": 15.0,
        "tariff_number": "0406.20.90.20",
        "hazmat": false,
        "alcohol": false,
        "misc": null,
        "notify_originator_inventory": true,
        "returnable": true,
        "category": null,
        "ean": "nill",
        "contains_small_batteries": false,
        "packaging_type": "Box",
        "replenishment_min": 0,
        "replenishment_target": 0,
        "velocity": 0,
        "origin_country": null,
        "originators": [
          {
            "group_id": "98754",
            "original_id": "76543",
            "provider": "example_provider"
          }
        ]
      }
    }
  ],
  "event_name": "item.low_inventory"
}
    

item.out_of_stock

Sent when an item's inventory has fallen below one

{
  "item": {
    "available": true,
    "created_at": "2015-03-06T20:31:34.000Z",
    "description": "XXL",
    "height": 0.2,
    "id": 12345,
    "customer_id": 4532,
    "image_file_name": null,
    "image_originator_url": null,
    "image_updated_at": null,
    "is_bundle": false,
    "length": 25.0,
    "media_mail": false,
    "lot_control": false,
    "packaging": false,
    "price": 22.0,
    "quantity": 2,
    "published_quantity": 2,
    "sku": "TI-Shirt-XXL",
    "scancode": "GSJ-220097",
    "currency": "USD",
    "street_date": null,
    "title": "Test Item T-Shirt",
    "updated_at": "2015-03-06T22:14:51.000Z",
    "vendor": "Example Vending",
    "weight": 0.5,
    "wholesale_cost": 15.0,
    "width": 15.0,
    "tariff_number": "0406.20.90.20",
    "hazmat": false,
    "alcohol": false,
    "misc": null,
    "notify_originator_inventory": true,
    "returnable": true,
    "category": null,
    "ean": "nill",
    "contains_small_batteries": false,
    "packaging_type": "Box",
    "replenishment_min": 0,
    "replenishment_target": 0,
    "velocity": 0,
    "origin_country": null,
    "originators": [
      {
        "group_id": "98754",
        "original_id": "76543",
        "provider": "example_provider"
      }
    ]
  },
  "event_name": "item.out_of_stock"
}
    

order.attention

Sent when an order requires attention due to issues.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 90,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Paused",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.attention"
}
    

order.batched

An order has been added to a batch.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 100,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Processing",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.batched"
}
    

order.created

Sent when an order is created.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 100,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Processing",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.created"
}
    

order.delivered

Sent when any order is delivered.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 350,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      "911111111111111111111"
    ],
    "tracking_links": [
      "http://www.usps/com/tracking/911111111111111111111"
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Delivered",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [
      {
        "id": 2306269,
        "order_id": 2649473,
        "shipped_on": "2018-06-11T12:26:46-04:00",
        "ship_actual_cost": "4.66",
        "actual_weight": "15.0",
        "actual_width": "18.0",
        "actual_height": "0.1",
        "actual_length": "24.0",
        "actual_dimensional_weight": "43.2",
        "tracking": "9400136895357015897459",
        "tracking_link": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400136895357015897459",
        "bill_of_lading": null,
        "created_at": "2018-03-22T13:12:08-04:00",
        "updated_at": "2018-06-11T16:26:46-04:00",
        "ucc128": null,
        "order_item_ids": [
          6324275,
          6324276,
          6324277
        ]
      }
    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.delivered"
}
    

order.empty_cancelled

Sent when an empty order is received by Whiplash and subsequently canceled.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 40,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Cancelled",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.empty_cancelled"
}
    

order.insufficient_inventory

Sent when an order is paused due to insufficient inventory.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 95,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Insufficient Inventory",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.insufficient_inventory"
}
    

order.non_merchandise_cancelled

An order containing only packaging items was received by Whiplash and subsequently canceled.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 40,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Cancelled",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.non_merchandise_cancelled"
}
    

order.non_merchandise_paused

An order containing only packaging items was received by Whiplash and subsequently paused.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 90,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Paused",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.non_merchandise_paused"
}
    

order.requires_label

An order that requires a label has been packed.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 160,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Packed",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [
      {
        "id": 2306269,
        "order_id": 2649473,
        "shipped_on": "2018-06-11T12:26:46-04:00",
        "ship_actual_cost": "4.66",
        "actual_weight": "15.0",
        "actual_width": "18.0",
        "actual_height": "0.1",
        "actual_length": "24.0",
        "actual_dimensional_weight": "43.2",
        "tracking": "9400136895357015897459",
        "tracking_link": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400136895357015897459",
        "bill_of_lading": null,
        "created_at": "2018-03-22T13:12:08-04:00",
        "updated_at": "2018-06-11T16:26:46-04:00",
        "ucc128": null,
        "order_item_ids": [
          6324275,
          6324276,
          6324277
        ]
      }
    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.requires_label"
}
    

order.return_to_sender

Sent when an order is returning to Whiplash because it was undeliverable.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 400,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Returned Undeliverable",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [
      {
        "id": 2306269,
        "order_id": 2649473,
        "shipped_on": "2018-06-11T12:26:46-04:00",
        "ship_actual_cost": "4.66",
        "actual_weight": "15.0",
        "actual_width": "18.0",
        "actual_height": "0.1",
        "actual_length": "24.0",
        "actual_dimensional_weight": "43.2",
        "tracking": "9400136895357015897459",
        "tracking_link": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400136895357015897459",
        "bill_of_lading": null,
        "created_at": "2018-03-22T13:12:08-04:00",
        "updated_at": "2018-06-11T16:26:46-04:00",
        "ucc128": null,
        "order_item_ids": [
          6324275,
          6324276,
          6324277
        ]
      }
    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.return_to_sender"
}
    

order.shipped

Sent when any order is shipped.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 300,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      "911111111111111111111"
    ],
    "tracking_links": [
      "http://www.usps/com/tracking/911111111111111111111"
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Shipped",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [
      {
        "id": 2306269,
        "order_id": 2649473,
        "shipped_on": "2018-06-11T12:26:46-04:00",
        "ship_actual_cost": "4.66",
        "actual_weight": "15.0",
        "actual_width": "18.0",
        "actual_height": "0.1",
        "actual_length": "24.0",
        "actual_dimensional_weight": "43.2",
        "tracking": "9400136895357015897459",
        "tracking_link": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400136895357015897459",
        "bill_of_lading": null,
        "created_at": "2018-03-22T13:12:08-04:00",
        "updated_at": "2018-06-11T16:26:46-04:00",
        "ucc128": null,
        "order_item_ids": [
          6324275,
          6324276,
          6324277
        ]
      }
    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.shipped"
}
    

order.status_changed

Sent when the status of an order changes.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 100,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Processing",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.status_changed"
}
    

order.unbatched

An order has been removed from a batch.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 100,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Processing",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.unbatched"
}
    

order.unmatched_ship_country

Sent when we are unable to match a destination country for an order.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 90,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Paused",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.unmatched_ship_country"
}
    

order.unmatched_ship_method

Sent when a ship method specified for an order cannot be matched.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 90,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Paused",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.unmatched_ship_method"
}
    

order.warehouse_fallback

Sent when the designated warehouse for an order is out of stock but another warehouse can be used.

{
  "order": {
    "id": 1234567,
    "customer_id": 4532,
    "billed": false,
    "created_at": "2015-03-11T07:50:33.000Z",
    "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:33.000Z",
    "shop_updated_at": "2015-03-11T07:50:33.000Z",
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_method": "USPS Priority Mail",
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22.000Z",
    "shipping_method_id": 37,
    "estimated_shipping_method_id": 6,
    "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,
    "billing_address_1": "1334 San Mateo Avenue",
    "billing_address_2": "",
    "billing_address_3": null,
    "billing_city": "South San Francisco",
    "billing_company": "",
    "billing_country": "United States",
    "billing_name": null,
    "billing_phone": "1231234567",
    "billing_state": "CA",
    "billing_zip": 94080,
    "status": 95,
    "shipping_confirmation_sent": false,
    "updated_at": "2015-03-11T13:50:27.000Z",
    "tracking": [
      null
    ],
    "tracking_links": [
      null
    ],
    "approximate_delivery_date": "2013-06-07",
    "originator_id": "54321",
    "originator_group_id": "3842687234",
    "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,
    "return_warehouse_id": 5,
    "address_verified": true,
    "address_message": null,
    "require_adult_signature": false,
    "contains_alcohol": false,
    "monetary_value": 100.0,
    "status_name": "Insufficient Inventory",
    "skip_address_verification": false,
    "reference": "54321",
    "return_address_1": null,
    "return_address_2": null,
    "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,
    "carrier_account_id": null,
    "customer_provided_label_carrier": null,
    "incoterm": null,
    "shipping_department": null,
    "shipping_distribution_center": null,
    "shipping_vendor": null,
    "residential": true,
    "meta_data": "{}",
    "packages": [

    ],
    "packingslip_pdf_url": null,
    "order_items": [
      {
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T07:50:34.000Z",
        "serialnumbers": [
          111222333
        ],
        "lots": [
          {
            "number": "123abc",
            "expires_on": "2020-01-01"
          },
          {
            "number": "222abc",
            "expires_on": "2030-01-01"
          }
        ]
      },
      {
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "promo": false,
        "is_bundle": 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:33.000Z",
        "updated_at": "2015-03-11T13:48:59.000Z",
        "serialnumbers": [
          22223333444
        ],
        "lots": [

        ]
      }
    ]
  },
  "event_name": "order.warehouse_fallback"
}
    

shipnotice.created

Sent when a shipnotice is created.

{
  "shipnotice": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "sender": "Your Company",
    "status": 50,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "Draft",
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "meta_data": "{}",
    "reference": null,
    "shipnotice_items": [
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.6,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "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",
          "scancode": "GSJ-220097",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.20",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98754",
              "original_id": "76543",
              "provider": "example_provider"
            }
          ]
        }
      },
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.4,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "description": "XL",
          "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-XL",
          "scancode": "GSJ-220098",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.25",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98755",
              "original_id": "76544",
              "provider": "example_provider"
            }
          ]
        }
      }
    ],
    "shipnotice_images": {
      "id": 2846,
      "shipnotice_id": 1211,
      "image_file_name": "your_image.jpg",
      "image_content_type": "image/jpeg",
      "image_file_size": 232096,
      "created_at": "2015-03-01T07:50:33.000Z",
      "updated_at": "2015-03-01T07:50:33.000Z"
    }
  },
  "event_name": "shipnotice.created"
}
    

shipnotice.incomplete

Sent when a shipnotice is received but the inventory hasn't given a location.

{
  "shipnotice": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "sender": "Your Company",
    "status": 300,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "Complete",
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "meta_data": "{}",
    "reference": null,
    "shipnotice_items": [
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.6,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "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",
          "scancode": "GSJ-220097",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.20",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98754",
              "original_id": "76543",
              "provider": "example_provider"
            }
          ]
        }
      },
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.4,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "description": "XL",
          "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-XL",
          "scancode": "GSJ-220098",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.25",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98755",
              "original_id": "76544",
              "provider": "example_provider"
            }
          ]
        }
      }
    ],
    "shipnotice_images": {
      "id": 2846,
      "shipnotice_id": 1211,
      "image_file_name": "your_image.jpg",
      "image_content_type": "image/jpeg",
      "image_file_size": 232096,
      "created_at": "2015-03-01T07:50:33.000Z",
      "updated_at": "2015-03-01T07:50:33.000Z"
    }
  },
  "event_name": "shipnotice.incomplete"
}
    

shipnotice.status_changed

Sent when the status of shipnotice changes.

{
  "shipnotice": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "sender": "Your Company",
    "status": 100,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "In Transit",
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "meta_data": "{}",
    "reference": null,
    "shipnotice_items": [
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.6,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "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",
          "scancode": "GSJ-220097",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.20",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98754",
              "original_id": "76543",
              "provider": "example_provider"
            }
          ]
        }
      },
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.4,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "description": "XL",
          "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-XL",
          "scancode": "GSJ-220098",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.25",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98755",
              "original_id": "76544",
              "provider": "example_provider"
            }
          ]
        }
      }
    ],
    "shipnotice_images": {
      "id": 2846,
      "shipnotice_id": 1211,
      "image_file_name": "your_image.jpg",
      "image_content_type": "image/jpeg",
      "image_file_size": 232096,
      "created_at": "2015-03-01T07:50:33.000Z",
      "updated_at": "2015-03-01T07:50:33.000Z"
    }
  },
  "event_name": "shipnotice.status_changed"
}
    

shipnotice.unexpected

Sent when a shipnotice is unexpected.

{
  "shipnotice": {
    "arrived_at": null,
    "completed_at": null,
    "eta": "2015-03-14T16:10:11.000Z",
    "id": 1211,
    "customer_id": 4532,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "sender": "Your Company",
    "status": 25,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "Unexpected",
    "created_at": "2015-03-12T16:10:11.000Z",
    "updated_at": "2015-03-12T16:10:11.000Z",
    "meta_data": "{}",
    "reference": null,
    "shipnotice_items": [
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.6,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "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",
          "scancode": "GSJ-220097",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.20",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98754",
              "original_id": "76543",
              "provider": "example_provider"
            }
          ]
        }
      },
      {
        "available": true,
        "created_at": "2015-03-01T07:50:33.000Z",
        "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:33.000Z",
        "weight": 7.4,
        "width": 12,
        "item": {
          "available": true,
          "created_at": "2015-03-06T20:31:34.000Z",
          "description": "XL",
          "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-XL",
          "scancode": "GSJ-220098",
          "currency": "USD",
          "street_date": null,
          "title": "Test Item T-Shirt",
          "updated_at": "2015-03-06T22:14:51.000Z",
          "vendor": "Example Vending",
          "weight": 0.5,
          "wholesale_cost": 15.0,
          "width": 15.0,
          "tariff_number": "0406.20.90.25",
          "hazmat": false,
          "misc": null,
          "notify_originator_inventory": true,
          "returnable": true,
          "category": null,
          "originators": [
            {
              "group_id": "98755",
              "original_id": "76544",
              "provider": "example_provider"
            }
          ]
        }
      }
    ],
    "shipnotice_images": {
      "id": 2846,
      "shipnotice_id": 1211,
      "image_file_name": "your_image.jpg",
      "image_content_type": "image/jpeg",
      "image_file_size": 232096,
      "created_at": "2015-03-01T07:50:33.000Z",
      "updated_at": "2015-03-01T07:50:33.000Z"
    }
  },
  "event_name": "shipnotice.unexpected"
}
    

shipnotice_item.quantity_received

translation missing: en.notifications.labels.shipnotice_item.quantity_received.description

{
  "shipnotice_item": {
    "available": true,
    "created_at": "2015-03-01T07:50:33.000Z",
    "description": null,
    "extended_description": null,
    "retail_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:33.000Z",
    "weight": 7.6,
    "width": 12
  },
  "transaction": {
    "change": 10,
    "created_at": "2014-09-16T05:02:18Z",
    "description": "Returned to stock from Order 12344, + 1",
    "item_id": 12345,
    "order_id": null,
    "quantity": 10,
    "shipnotice_id": 17211,
    "updated_at": "2014-09-16T05:02:18Z"
  },
  "event_name": "shipnotice_item.quantity_received"
}