Web Hooks

M Montroy
M Montroy
  • Updated

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

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

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

Web Hooks are editable on your preferences page. Additionally, you can create, list, and delete web hooks via The Whiplash API.

Verifying Web Hooks

You can verify that a web hook is really 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 the SHA256 hash algorithm, your API Key, and the web hook's request body.

For example, in Ruby this would look like:

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)
    

Testing your Web Hook

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 support notifications for many order, inventory, shipnotice & consumer return events. example payloads from our most-used webhooks are below for your reference:

Order Shipped

{
  "event_name": "order.shipped",
  "order": {
    "billed": false,
    "created_at": "2015-03-11T07:50:33Z",
    "days_in_transit": 1,
    "email": "whiplash@whiplashmerch.com",
    "gift": false,
    "id": 1234567,
    "reference": "54321",
    "insure": false,
    "originator_notified": true,
    "pack_fee_actual": null,
    "packaging_fee_actual": null,
    "pick_fee_actual": null,
    "public_note": null,
    "require_signature": false,
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22Z",
    "shipping_address_1": "1334 San Mateo Avenue",
    "shipping_address_2": "",
    "shipping_city": "South San Francisco",
    "shipping_company": null,
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_name": "James Hetfield",
    "shipping_phone": "1231234567",
    "shipping_state": "CA",
    "shipping_zip": 94080,
    "shop_shipping_method_price": 8.85,
    "shop_shipping_method_text": "USPS Priority Mail 2-Day",
    "shop_shipping_method_currency": "USD",
    "shop_created_at": "2015-03-11T07:50:33Z",
    "shop_updated_at": "2015-03-11T07:50:33Z",
    "shop_warehouse_id": 1,
    "status": 300,
    "total_fee_actual": null,
    "tracking_sent": true,
    "updated_at": "2015-03-11T13:50:27Z",
    "fees": {
      "pick": 0.25,
      "pack": 2.95,
      "packaging": 0.0,
      "postage": 5.34,
      "total": 8.63
    },
    "tracking": [
      "911111111111111111111"
    ],
    "originator_id": "54321",
    "provider": "example_provider",
    "monetary_value": 100.0,
    "insurance_value": 100.18,
    "ship_method": "USPS Priority Mail",
    "status_name": "Shipped",
    "order_items": [
      {
        "available": true,
        "created_at": "2015-03-11T07:50:33Z",
        "description": "Test Item LP",
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 70.0,
        "quantity": 1,
        "sku": "TI-LP",
        "updated_at": "2015-03-11T07:50:34Z",
        "originator_id": "76543",
        "provider": "example_provider",
        "serialnumbers": [
          111222333
        ]
      },
      {
        "available": true,
        "created_at": "2015-03-11T07:50:33Z",
        "description": "Test Item T-Shirt, Small",
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 49.5,
        "quantity": 1,
        "sku": "TI-Shirt-S",
        "updated_at": "2015-03-11T13:48:59Z",
        "originator_id": "76522",
        "provider": "example_provider",
        "serialnumbers": [
          22223333444
        ]
      }
    ],
    "packages": [
      {
        "tracking": "1ZE190000000000000",
        "shipped_on": "2015-03-11T13:50:27Z",
        "bill_of_lading": null,
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T13:50:27Z",
        "pick_fee": 0.0,
        "pack_fee": 2.95,
        "packaging_fee": 3.17,
        "weight": 621.0,
        "shipping_cost": 28.48,
        "packaging_type": "Parcel",
        "order_item_ids": [
          1233,
          1234
        ]
      },
      {
        "tracking": "1ZE190860000000000",
        "shipped_on": "2015-03-11T13:50:27Z",
        "bill_of_lading": 234234234234,
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T13:50:27Z",
        "pick_fee": 0.0,
        "pack_fee": 2.95,
        "packaging_fee": 3.17,
        "weight": 121.0,
        "shipping_cost": 8.48,
        "packaging_type": "Parcel",
        "order_item_ids": [
          1245,
          4321
        ]
      }
    ]
  }
}
    
Note: Fees hash is not exposed consistently. It will show if the order is billed in Whiplash and when the Webhook is sent. Billing depends the jobs running in the background.

Back to top of Events

Item Created

{
  "item": {
    "id": 2467255,
    "sku": "Com-12B-RT",
    "title": "But the gardener won't lettuce...",
    "description": "101 puns to share at supper time",
    "full_description": "But the gardener won't lettuce..., 101 puns to share at supper time",
    "original_location": null,
    "created_at": "2022-02-25T17:54:13.000-05:00",
    "updated_at": "2022-02-25T17:54:13.000-05:00",
    "customer_id": 2779,
    "quantity": 0,
    "weight": null,
    "available": false,
    "image_originator_url": "",
    "vendor": null,
    "scancode": null,
    "price": "5.99",
    "media_mail": false,
    "packaging": false,
    "length": null,
    "width": null,
    "height": null,
    "active": true,
    "wholesale_cost": null,
    "is_bundle": false,
    "packaging_type": null,
    "promo": false,
    "street_date": null,
    "category": null,
    "include_inbound_in_published": false,
    "returnable": null,
    "return_sku_match": null,
    "return_price_restricted": null,
    "request_serial_number": null,
    "currency": "USD",
    "tariff_number": null,
    "label_format": null,
    "notify_originator_inventory": null,
    "name": "But the gardener won't lettuce..., 101 puns to share at supper time",
    "image_url": null,
    "hazmat": true,
    "hazmat_type": "",
    "misc": null,
    "ean": null,
    "lot_control": false,
    "expiration_period": null,
    "ship_strategy": 0,
    "velocity": 0,
    "case_quantity": null,
    "carton_quantity": null,
    "origin_country": null,
    "alcohol": false,
    "shippable_container": false,
    "replenishment_min": null,
    "replenishment_target": null,
    "low_inventory_threshold": null,
    "published_quantity": 0
  },
  "event_name": "item.created"
}

Back to top of Events


Item Low Inventory

Fires when...

- An item's inventory drops below its low inventory threshold (to be declared).

NOTE: This webhook fires nightly, not instantaneously

{
  "item": {
    "id": 1244292,
    "sku": "ST-0004",
    "title": "Simple Syrup",
    "description": "Size 4",
    "full_description": "How sugar water changes cocktails and coffee beverages!",
    "original_location": null,
    "created_at": "2020-09-16T17:03:15.000-04:00",
    "updated_at": "2020-09-16T17:03:19.000-04:00",
    "customer_id": 3545,
    "quantity": 9,
    "weight": "4.6",
    "available": false,
    "image_originator_url": null,
    "vendor": null,
    "scancode": "00ST0004",
    "price": "0.0",
    "media_mail": false,
    "packaging": false,
    "length": "20.0",
    "width": "14.5",
    "height": "11.0",
    "active": true,
    "wholesale_cost": null,
    "is_bundle": false,
    "packaging_type": null,
    "promo": false,
    "street_date": null,
    "category": null,
    "include_inbound_in_published": false,
    "returnable": null,
    "return_sku_match": null,
    "return_price_restricted": null,
    "request_serial_number": null,
    "currency": "USD",
    "tariff_number": null,
    "label_format": null,
    "notify_originator_inventory": 0,
    "name": "Simple Twill, Size 4",
    "image_url": null,
    "hazmat": false,
    "hazmat_type": null,
    "misc": null,
    "ean": null,
    "lot_control": false,
    "expiration_period": null,
    "ship_strategy": 0,
    "velocity": 0,
    "case_quantity": null,
    "carton_quantity": null,
    "origin_country": null,
    "alcohol": false,
    "replenishment_min": null,
    "replenishment_target": null,
    "low_inventory_threshold": null,
    "published_quantity": 9
  },
  "event_name": "item.low_inventory"
}

Back to top of Events


Item Inventory Adjusted

Fires when...
- There is a location audit (increase or decrease)
- There is a manual adjustment in the UI (increase or decrease)

 

Payload of an audit:

{
  "item": {
    "id": 2467243,
    "sku": "Eco-231-GG",
    "title": "The Economics of Banana Stickers",
    "description": "An insight into 8th grader bartering systems!",
    "full_description": "The Economics of Banana Stickers, An insight into 8th grader bartering systems!",
    "original_location": null,
    "created_at": "2022-02-25T16:41:07.000-05:00",
    "updated_at": "2022-02-28T17:16:22.000-05:00",
    "customer_id": 2779,
    "quantity": 12,
    "weight": "0.25",
    "available": true,
    "image_originator_url": "",
    "vendor": "",
    "scancode": "12-sl-20-05",
    "price": "24.99",
    "media_mail": false,
    "packaging": false,
    "length": "5.0",
    "width": "6.0",
    "height": "7.0",
    "active": true,
    "wholesale_cost": null,
    "is_bundle": false,
    "packaging_type": null,
    "promo": false,
    "street_date": null,
    "category": "",
    "include_inbound_in_published": false,
    "returnable": null,
    "return_sku_match": "",
    "return_price_restricted": null,
    "request_serial_number": null,
    "currency": "USD",
    "tariff_number": "",
    "label_format": null,
    "notify_originator_inventory": null,
    "name": "The Economics of Banana Stickers, An insight into 8th grader bartering systems!",
    "image_url": null,
    "hazmat": true,
    "hazmat_type": "",
    "misc": null,
    "ean": null,
    "lot_control": false,
    "expiration_period": null,
    "ship_strategy": 0,
    "velocity": 0,
    "case_quantity": null,
    "carton_quantity": null,
    "origin_country": "",
    "alcohol": false,
    "shippable_container": false,
    "replenishment_min": null,
    "replenishment_target": null,
    "low_inventory_threshold": 5,
    "published_quantity": 12
  },
  "quantity": 8,
  "reason": {
    "code": "audit",
    "description": "Location audit"
  },
  "event_name": "item.inventory_adjusted"
}


Payload of a manual adjustment:

{
  "item": {
    "id": 2467445,
    "sku": "Horr-BOO-12",
    "title": "Dim candles in the night",
    "description": "10 chilling ghost stories for non-believers",
    "full_description": "Dim candles in the night, 10 chilling ghost stories for non-believers",
    "original_location": null,
    "created_at": "2022-02-28T15:23:53.000-05:00",
    "updated_at": "2022-03-04T15:24:27.000-05:00",
    "customer_id": 2779,
    "quantity": 104,
    "weight": "1.0",
    "available": true,
    "image_originator_url": "",
    "vendor": "",
    "scancode": "Horr-BOO-12",
    "price": "19.99",
    "media_mail": false,
    "packaging": false,
    "length": "1.0",
    "width": "1.0",
    "height": "1.0",
    "active": true,
    "wholesale_cost": null,
    "is_bundle": false,
    "packaging_type": null,
    "promo": false,
    "street_date": null,
    "category": "",
    "include_inbound_in_published": false,
    "returnable": null,
    "return_sku_match": "",
    "return_price_restricted": null,
    "request_serial_number": null,
    "currency": "USD",
    "tariff_number": "",
    "label_format": null,
    "notify_originator_inventory": null,
    "name": "Dim candles in the night, 10 chilling ghost stories for non-believers",
    "image_url": null,
    "hazmat": true,
    "hazmat_type": "",
    "misc": null,
    "ean": null,
    "lot_control": false,
    "expiration_period": null,
    "ship_strategy": 0,
    "velocity": 2,
    "case_quantity": null,
    "carton_quantity": null,
    "origin_country": "",
    "alcohol": false,
    "shippable_container": false,
    "replenishment_min": null,
    "replenishment_target": null,
    "low_inventory_threshold": 100,
    "published_quantity": 104
  },
  "quantity": 5,
  "reason": {
    "code": "repair",
    "description": null
  },
  "event_name": "item.inventory_adjusted"
}

 

Back to top of Events

Item Inventory Received

Fires when...
- Items are allocated to a physical shelf location in the warehouse from a Shipnotice. Sent instantaneously, not when the entire Shipnotice is finished & notified.

{
  "item": {
    "id": 2467445,
    "sku": "Horr-BOO-12",
    "title": "Dim candles in the night",
    "description": "10 chilling ghost stories for non-believers",
    "full_description": "Dim candles in the night, 10 chilling ghost stories for non-believers",
    "original_location": null,
    "created_at": "2022-02-28T15:23:53.000-05:00",
    "updated_at": "2022-02-28T15:32:27.000-05:00",
    "customer_id": 2779,
    "quantity": 10,
    "weight": "1.0",
    "available": true,
    "image_originator_url": "",
    "vendor": null,
    "scancode": "Horr-BOO-12",
    "price": "19.99",
    "media_mail": false,
    "packaging": false,
    "length": "1.0",
    "width": "1.0",
    "height": "1.0",
    "active": true,
    "wholesale_cost": null,
    "is_bundle": false,
    "packaging_type": null,
    "promo": false,
    "street_date": null,
    "category": null,
    "include_inbound_in_published": false,
    "returnable": null,
    "return_sku_match": null,
    "return_price_restricted": null,
    "request_serial_number": null,
    "currency": "USD",
    "tariff_number": null,
    "label_format": null,
    "notify_originator_inventory": null,
    "name": "Dim candles in the night, 10 chilling ghost stories for non-believers",
    "image_url": null,
    "hazmat": true,
    "hazmat_type": "",
    "misc": null,
    "ean": null,
    "lot_control": false,
    "expiration_period": null,
    "ship_strategy": 0,
    "velocity": 0,
    "case_quantity": null,
    "carton_quantity": null,
    "origin_country": null,
    "alcohol": false,
    "shippable_container": false,
    "replenishment_min": null,
    "replenishment_target": null,
    "low_inventory_threshold": null,
    "published_quantity": 10
  },
  "quantity": 10,
  "role": "pickable",
  "event_name": "item.inventory_received"
}

 

Back to top of Events

Item Inventory Changed

Fires when...

- Items are allocated to a physical shelf location in the warehouse from a Shipnotice. Sent instantaneously, not when the entire Shipnotice is finished & notified.

- There is a location audit (increase or decrease)
- There is a manual adjustment in the UI (increase or decrease)

- Items are added to an order

- Items are returned to the shelf after being removed from an order

 

Payload when items are allocated from Shipnotice:

{
"item": {
"id": 2467244,
"sku": "123-app-le",
"title": "Honey Crisp",
"description": "Honey crisp apple",
"full_description": "Honey Crisp, Honey crisp apple",
"original_location": null,
"created_at": "2022-02-25T16:41:15.000-05:00",
"updated_at": "2022-02-25T16:47:50.000-05:00",
"customer_id": 2780,
"quantity": 1000,
"weight": "1.0",
"available": true,
"image_originator_url": "",
"vendor": null,
"scancode": "112honeyc11",
"price": "5.99",
"media_mail": false,
"packaging": false,
"length": "1.0",
"width": "1.0",
"height": "1.0",
"active": true,
"wholesale_cost": null,
"is_bundle": false,
"packaging_type": null,
"promo": false,
"street_date": null,
"category": null,
"include_inbound_in_published": false,
"returnable": null,
"return_sku_match": null,
"return_price_restricted": null,
"request_serial_number": null,
"currency": "USD",
"tariff_number": null,
"label_format": null,
"notify_originator_inventory": null,
"name": "Honey Crisp, Honey crisp apple",
"image_url": null,
"hazmat": true,
"hazmat_type": "",
"misc": null,
"ean": null,
"lot_control": false,
"expiration_period": null,
"ship_strategy": 0,
"velocity": 0,
"case_quantity": null,
"carton_quantity": null,
"origin_country": null,
"alcohol": false,
"shippable_container": false,
"replenishment_min": null,
"replenishment_target": null,
"low_inventory_threshold": null,
"published_quantity": 1000
},
"transaction": {
"id": 9099832,
"description": "Allocated Inventory from Alicia W, + 1000",
"quantity": 1000,
"change": 1000,
"created_at": "2022-02-25 16:47:50 -0500",
"updated_at": "2022-02-25 16:47:50 -0500",
"item_id": 2467244,
"order_id": null,
"shipnotice_id": 176226
},
"warehouse_quantities": [
{
"id": 1,
"name": "Ann Arbor",
"shipping_address_1": "4657 Platt Road",
"shipping_address_2": "",
"shipping_city": "Ann Arbor",
"shipping_state": "Michigan",
"shipping_zip": "48108",
"shipping_country": "United States",
"shipping_country_iso2": "US",
"email": "annarbor@whiplashmerch.com",
"latitude": 42.2206,
"longitude": -83.6989,
"quantity": 1000,
"projected_quantity": 1000,
"sellable_quantity": 1000
}
],
"event_name": "item.inventory_changed"
}

 

Back to top of Events

Ship Notice Created

{
  "shipnotice": {
    "id": 176227,
    "customer_id": 2779,
    "warehouse_id": 1,
    "sender": "Mario ",
    "eta": "2022-02-24T19:00:00.000-05:00",
    "status": 100,
    "status_name": "In Transit",
    "received_by": null,
    "notes_by_whiplash": null,
    "notes_by_customer": null,
    "total_boxes": null,
    "created_at": "2022-02-25T16:48:19.000-05:00",
    "updated_at": "2022-02-25T16:48:19.000-05:00",
    "arrived_at": null,
    "skip_images": null,
    "easypostable_id": null,
    "easypostable_type": "Shipment",
    "shipping_label_url": null,
    "ship_actual_cost": null,
    "shipping_method_text": null,
    "carrier": null,
    "shipping_method_id": null,
    "tracking": "",
    "order_id": null,
    "type": "Shipnotice",
    "postage_billed": null,
    "handling_billed": null,
    "ship_3rdparty_cost": null,
    "requires_label": true,
    "completed_at": null,
    "complete_by": "2022-02-27T19:00:00.000-05:00",
    "ship_actual_currency": null,
    "delivered_at": null,
    "due_at": null,
    "meta_data": null,
    "reference": "",
    "shipnotice_item_count": 0,
    "shipnotice_item_quantity": 0,
    "purchase_order_numbers": [],
    "customer": {
      "id": 2779,
      "name": "Joey's Books",
      "created_at": "2022-02-25T16:17:45.000-05:00",
      "active": true,
      "auto_merge_gestation": null,
      "default_warehouse_id": 1,
      "eori_number": null,
      "estimated_monthly_volume": null,
      "fedex_account": null,
      "from_email": null,
      "instructions": null,
      "item_scanning_preference": true,
      "label_format": null,
      "notes": null,
      "notify_originator": true,
      "notify_originator_inventory": 2,
      "originator_permissions": false,
      "packing_slip_msg": null,
      "packingslip_template": null,
      "request_serial_numbers": false,
      "ship_method_preference": 0,
      "shipping_name": "Joey's Books",
      "ups_account": null,
      "vat_number": null,
      "ein": null,
      "warehouse_fallback": 0,
      "payment_hold": false,
      "whitelisted_warehouses": [
        {
          "id": 1,
          "name": "Ann Arbor",
          "timezone": "Eastern Time (US & Canada)",
          "timezone_raw": "America/New_York",
          "shipping_address_1": "4657 Platt Road",
          "shipping_address_2": "",
          "shipping_city": "Ann Arbor",
          "shipping_state": "Michigan",
          "shipping_zip": "48108",
          "shipping_country": "United States",
          "shipping_country_iso2": "US",
          "latitude": 42.2206,
          "longitude": -83.6989
        }
      ],
      "allowed_warehouse_ids": [
        1
      ],
      "account_level": 200,
      "account_level_name": null,
      "activated_at": "2022-02-25T16:18:12.000-05:00",
      "deactivated_at": null,
      "auto_merge_skus": false,
      "billing_email": "Joe.Bookman@joeysbooks.com",
      "billing_contact_name": "Joe Bookman",
      "billing_company": null,
      "billing_phone1": "212-212-1212",
      "billing_phone2": null,
      "billing_address1": null,
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": null,
      "billing_state": null,
      "billing_zip": null,
      "billing_country": "US",
      "billing_residential": null,
      "items_returnable": true,
      "allow_international_returns": true,
      "items_exchangeable": true,
      "return_time_limit": 30,
      "return_label_expires_in": 29,
      "return_price_restricted": true,
      "return_sku_match": null,
      "rma_display_logo": true,
      "rma_footer_content": null,
      "return_name": null,
      "return_company": null,
      "return_email": null,
      "return_phone": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_zip": null,
      "return_country": null,
      "supports_return_labels": true,
      "logo_content_type": null,
      "logo_file_name": null,
      "logo_file_size": null,
      "logo_updated_at": null,
      "full_logo_url": "",
      "email_confirmation_from": "Joe.Bookman@joeysbooks.com",
      "email_confirmation_name": "Joe Bookman",
      "email_confirmation_msg": null,
      "email_confirmation_preference": 0,
      "email_confirmation_template": null,
      "low_inventory_threshold": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 1,
      "items_unavailable_on_sellout": 1,
      "replenishment_min": null,
      "replenishment_target": null,
      "location_default_return_role": "pickable",
      "location_enable_pending_returns": false
    },
    "warehouse": {
      "id": 1,
      "name": "Ann Arbor",
      "timezone": "Eastern Time (US & Canada)",
      "timezone_raw": "America/New_York",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": "",
      "shipping_city": "Ann Arbor",
      "shipping_state": "Michigan",
      "shipping_zip": "48108",
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "latitude": 42.2206,
      "longitude": -83.6989
    },
    "originator": {
      "id": 11289123,
      "originated_id": 176227,
      "originated_type": "Shipnotice",
      "shop_id": null,
      "provider": "whiplash:manual",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-02-25T16:48:19.000-05:00",
      "updated_at": "2022-02-25T16:48:19.000-05:00",
      "application_id": 6
    },
    "inspection_required": false,
    "shipping_method": null,
    "shipnotice_items": []
  },
  "fees": {},
  "event_name": "shipnotice.created"
}

 

Back to top of Events

Ship Notice Status Changed

Fires when...

- A Shipnotice is moved to Received status (the warehouse started allocating the inventory)

- A Shipnotice is moved to Completed status (the warehouse finished allocating the inventory)

- A Shipnotice is re-opened (because the warehouse needs to correct a Shipnotice)

NOTE: This webhook will not fire in the event that a Shipnotice has been destroyed/deleted

Payload of a received or re-opened Shipnotice:

  "shipnotice": {
    "id": 176227,
    "customer_id": 2779,
    "warehouse_id": 1,
    "sender": "Mario ",
    "eta": "2022-02-24T19:00:00.000-05:00",
    "status": 200,
    "status_name": "Processing",
    "received_by": "2932",
    "notes_by_whiplash": null,
    "notes_by_customer": null,
    "total_boxes": null,
    "created_at": "2022-02-25T16:48:19.000-05:00",
    "updated_at": "2022-02-25T17:02:32.000-05:00",
    "arrived_at": "2022-02-25T17:02:32.000-05:00",
    "skip_images": null,
    "easypostable_id": null,
    "easypostable_type": "Shipment",
    "shipping_label_url": null,
    "ship_actual_cost": null,
    "shipping_method_text": null,
    "carrier": null,
    "shipping_method_id": null,
    "tracking": "",
    "order_id": null,
    "type": "Shipnotice",
    "postage_billed": null,
    "handling_billed": null,
    "ship_3rdparty_cost": null,
    "requires_label": true,
    "completed_at": null,
    "complete_by": "2022-02-28T17:02:32.000-05:00",
    "ship_actual_currency": null,
    "delivered_at": "2022-02-25T17:02:32.000-05:00",
    "due_at": "2022-02-28T16:00:00.000-05:00",
    "meta_data": null,
    "reference": "",
    "shipnotice_item_count": 1,
    "shipnotice_item_quantity": 10,
    "purchase_order_numbers": [],
    "customer": {
      "id": 2779,
      "name": "Joey's Books",
      "created_at": "2022-02-25T16:17:45.000-05:00",
      "active": true,
      "auto_merge_gestation": null,
      "default_warehouse_id": 1,
      "eori_number": null,
      "estimated_monthly_volume": null,
      "fedex_account": null,
      "from_email": null,
      "instructions": null,
      "item_scanning_preference": true,
      "label_format": null,
      "notes": null,
      "notify_originator": true,
      "notify_originator_inventory": 2,
      "originator_permissions": false,
      "packing_slip_msg": null,
      "packingslip_template": null,
      "request_serial_numbers": false,
      "ship_method_preference": 0,
      "shipping_name": "Joey's Books",
      "ups_account": null,
      "vat_number": null,
      "ein": null,
      "warehouse_fallback": 0,
      "payment_hold": false,
      "whitelisted_warehouses": [
        {
          "id": 1,
          "name": "Ann Arbor",
          "timezone": "Eastern Time (US & Canada)",
          "timezone_raw": "America/New_York",
          "shipping_address_1": "4657 Platt Road",
          "shipping_address_2": "",
          "shipping_city": "Ann Arbor",
          "shipping_state": "Michigan",
          "shipping_zip": "48108",
          "shipping_country": "United States",
          "shipping_country_iso2": "US",
          "latitude": 42.2206,
          "longitude": -83.6989
        }
      ],
      "allowed_warehouse_ids": [
        1
      ],
      "account_level": 200,
      "account_level_name": null,
      "activated_at": "2022-02-25T16:18:12.000-05:00",
      "deactivated_at": null,
      "auto_merge_skus": false,
      "billing_email": "Joe.Bookman@joeysbooks.com",
      "billing_contact_name": "Joe Bookman",
      "billing_company": null,
      "billing_phone1": "212-212-1212",
      "billing_phone2": null,
      "billing_address1": null,
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": null,
      "billing_state": null,
      "billing_zip": null,
      "billing_country": "US",
      "billing_residential": null,
      "items_returnable": true,
      "allow_international_returns": true,
      "items_exchangeable": true,
      "return_time_limit": 30,
      "return_label_expires_in": 29,
      "return_price_restricted": true,
      "return_sku_match": null,
      "rma_display_logo": true,
      "rma_footer_content": null,
      "return_name": null,
      "return_company": null,
      "return_email": null,
      "return_phone": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_zip": null,
      "return_country": null,
      "supports_return_labels": true,
      "logo_content_type": null,
      "logo_file_name": null,
      "logo_file_size": null,
      "logo_updated_at": null,
      "full_logo_url": "",
      "email_confirmation_from": "Joe.Bookman@joeysbooks.com",
      "email_confirmation_name": "Joe Bookman",
      "email_confirmation_msg": null,
      "email_confirmation_preference": 0,
      "email_confirmation_template": null,
      "low_inventory_threshold": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 1,
      "items_unavailable_on_sellout": 1,
      "replenishment_min": null,
      "replenishment_target": null,
      "location_default_return_role": "pickable",
      "location_enable_pending_returns": false
    },
    "warehouse": {
      "id": 1,
      "name": "Ann Arbor",
      "timezone": "Eastern Time (US & Canada)",
      "timezone_raw": "America/New_York",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": "",
      "shipping_city": "Ann Arbor",
      "shipping_state": "Michigan",
      "shipping_zip": "48108",
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "latitude": 42.2206,
      "longitude": -83.6989
    },
    "originator": {
      "id": 11289123,
      "originated_id": 176227,
      "originated_type": "Shipnotice",
      "shop_id": null,
      "provider": "whiplash:manual",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-02-25T16:48:19.000-05:00",
      "updated_at": "2022-02-25T16:48:19.000-05:00",
      "application_id": 6
    },
    "inspection_required": false,
    "shipping_method": null,
    "shipnotice_items": [
      {
        "id": 401975,
        "shipnotice_id": 176227,
        "item_id": 2467243,
        "quantity": 10,
        "quantity_good": 10,
        "quantity_damaged": 0,
        "description": null,
        "extended_description": null,
        "include_in_published": false,
        "return_action": null,
        "purchase_order_number": null,
        "created_at": "2022-02-25T16:48:36.000-05:00",
        "updated_at": "2022-02-25T17:02:32.000-05:00",
        "item": {
          "id": 2467243,
          "sku": "Eco-231-GG",
          "title": "The Economics of Banana Stickers",
          "description": "An insight into 8th grader bartering systems!",
          "full_description": "The Economics of Banana Stickers, An insight into 8th grader bartering systems!",
          "original_location": null,
          "created_at": "2022-02-25T16:41:07.000-05:00",
          "updated_at": "2022-02-25T17:02:32.000-05:00",
          "customer_id": 2779,
          "quantity": 0,
          "weight": "0.25",
          "available": true,
          "image_originator_url": "",
          "vendor": null,
          "scancode": "12-sl-20-05",
          "price": "24.99",
          "media_mail": false,
          "packaging": false,
          "length": "5.0",
          "width": "6.0",
          "height": "7.0",
          "active": true,
          "wholesale_cost": null,
          "is_bundle": false,
          "packaging_type": null,
          "promo": false,
          "street_date": null,
          "category": null,
          "include_inbound_in_published": false,
          "returnable": null,
          "return_sku_match": null,
          "return_price_restricted": null,
          "request_serial_number": null,
          "currency": "USD",
          "tariff_number": null,
          "label_format": null,
          "notify_originator_inventory": null,
          "name": "The Economics of Banana Stickers, An insight into 8th grader bartering systems!",
          "image_url": null,
          "hazmat": true,
          "hazmat_type": "",
          "misc": null,
          "ean": null,
          "lot_control": false,
          "expiration_period": null,
          "ship_strategy": 0,
          "velocity": 0,
          "case_quantity": null,
          "carton_quantity": null,
          "origin_country": null,
          "alcohol": false,
          "shippable_container": false,
          "replenishment_min": null,
          "replenishment_target": null,
          "low_inventory_threshold": null,
          "published_quantity": 0
        },
        "lot": null,
        "warehouse_id": 1,
        "unallocated": 10
      }
    ]
  },
  "fees": {},
  "event_name": "shipnotice.status_changed"
}

 

Payload of a completed Shipnotice:

{
  "shipnotice": {
    "id": 176320,
    "customer_id": 2779,
    "warehouse_id": 1,
    "sender": "Jamal",
    "eta": "2022-03-03T19:00:00.000-05:00",
    "status": 300,
    "status_name": "Completed",
    "received_by": "2932",
    "notes_by_whiplash": null,
    "notes_by_customer": null,
    "total_boxes": null,
    "created_at": "2022-03-04T15:40:32.000-05:00",
    "updated_at": "2022-03-04T15:42:17.000-05:00",
    "arrived_at": "2022-03-04T15:41:59.000-05:00",
    "skip_images": null,
    "easypostable_id": null,
    "easypostable_type": "Shipment",
    "shipping_label_url": null,
    "ship_actual_cost": null,
    "shipping_method_text": null,
    "carrier": null,
    "shipping_method_id": null,
    "tracking": "",
    "order_id": null,
    "type": "Shipnotice",
    "postage_billed": null,
    "handling_billed": null,
    "ship_3rdparty_cost": null,
    "requires_label": true,
    "completed_at": "2022-03-04T15:42:17.000-05:00",
    "complete_by": "2022-03-07T15:41:59.000-05:00",
    "ship_actual_currency": null,
    "delivered_at": "2022-03-04T15:41:59.000-05:00",
    "due_at": "2022-03-07T16:00:00.000-05:00",
    "meta_data": null,
    "reference": "",
    "shipnotice_item_count": 1,
    "shipnotice_item_quantity": 100,
    "purchase_order_numbers": [],
    "customer": {
      "id": 2779,
      "name": "Joey's Books",
      "created_at": "2022-02-25T16:17:45.000-05:00",
      "active": true,
      "auto_merge_gestation": null,
      "default_warehouse_id": 1,
      "eori_number": null,
      "estimated_monthly_volume": null,
      "fedex_account": null,
      "from_email": null,
      "instructions": null,
      "item_scanning_preference": true,
      "label_format": null,
      "notes": null,
      "notify_originator": true,
      "notify_originator_inventory": 2,
      "originator_permissions": false,
      "packing_slip_msg": null,
      "packingslip_template": null,
      "request_serial_numbers": false,
      "ship_method_preference": 0,
      "shipping_name": "Joey's Books",
      "ups_account": null,
      "vat_number": null,
      "ein": null,
      "warehouse_fallback": 0,
      "payment_hold": false,
      "whitelisted_warehouses": [
        {
          "id": 1,
          "name": "Ann Arbor",
          "timezone": "Eastern Time (US & Canada)",
          "timezone_raw": "America/New_York",
          "shipping_address_1": "4657 Platt Road",
          "shipping_address_2": "",
          "shipping_city": "Ann Arbor",
          "shipping_state": "Michigan",
          "shipping_zip": "48108",
          "shipping_country": "United States",
          "shipping_country_iso2": "US",
          "latitude": 42.2206,
          "longitude": -83.6989,
          "slug": "ann-arbor"
        }
      ],
      "allowed_warehouse_ids": [
        1
      ],
      "account_level": 200,
      "account_level_name": null,
      "activated_at": "2022-02-25T16:18:12.000-05:00",
      "deactivated_at": null,
      "auto_merge_skus": false,
      "billing_email": "Joe.Bookman@joeysbooks.com",
      "billing_contact_name": "Joe Bookman",
      "billing_company": null,
      "billing_phone1": "212-212-1212",
      "billing_phone2": null,
      "billing_address1": null,
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": null,
      "billing_state": null,
      "billing_zip": null,
      "billing_country": "US",
      "billing_residential": null,
      "items_returnable": true,
      "allow_international_returns": true,
      "items_exchangeable": true,
      "return_time_limit": 30,
      "return_label_expires_in": 29,
      "return_price_restricted": true,
      "return_sku_match": null,
      "rma_display_logo": true,
      "rma_footer_content": null,
      "return_name": null,
      "return_company": null,
      "return_email": null,
      "return_phone": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_zip": null,
      "return_country": null,
      "supports_return_labels": true,
      "logo_content_type": null,
      "logo_file_name": null,
      "logo_file_size": null,
      "logo_updated_at": null,
      "full_logo_url": "",
      "email_confirmation_from": "Joe.Bookman@joeysbooks.com",
      "email_confirmation_name": "Joe Bookman",
      "email_confirmation_msg": null,
      "email_confirmation_preference": 0,
      "email_confirmation_template": null,
      "low_inventory_threshold": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 1,
      "items_unavailable_on_sellout": 1,
      "replenishment_min": null,
      "replenishment_target": null,
      "location_default_return_role": "pickable",
      "location_enable_pending_returns": false
    },
    "warehouse": {
      "id": 1,
      "name": "Ann Arbor",
      "timezone": "Eastern Time (US & Canada)",
      "timezone_raw": "America/New_York",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": "",
      "shipping_city": "Ann Arbor",
      "shipping_state": "Michigan",
      "shipping_zip": "48108",
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "latitude": 42.2206,
      "longitude": -83.6989,
      "slug": "ann-arbor"
    },
    "originator": {
      "id": 11301572,
      "originated_id": 176320,
      "originated_type": "Shipnotice",
      "shop_id": null,
      "provider": "whiplash:manual",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-04T15:40:32.000-05:00",
      "updated_at": "2022-03-04T15:40:32.000-05:00",
      "application_id": 6
    },
    "inspection_required": false,
    "shipping_method": null,
    "shipnotice_items": [
      {
        "id": 402260,
        "shipnotice_id": 176320,
        "item_id": 2467653,
        "quantity": 100,
        "quantity_good": 100,
        "quantity_damaged": 0,
        "description": null,
        "extended_description": null,
        "include_in_published": false,
        "return_action": null,
        "purchase_order_number": null,
        "created_at": "2022-03-04T15:40:50.000-05:00",
        "updated_at": "2022-03-04T15:41:59.000-05:00",
        "item": {
          "id": 2467653,
          "sku": "123-W23-WD",
          "title": "Test",
          "description": "It's a test book!",
          "full_description": "Test, It's a test book!",
          "original_location": null,
          "created_at": "2022-03-01T16:05:27.000-05:00",
          "updated_at": "2022-03-04T15:42:09.000-05:00",
          "customer_id": 2779,
          "quantity": 100,
          "weight": "1.0",
          "available": true,
          "image_originator_url": "",
          "vendor": null,
          "scancode": "123-W23-WD",
          "price": "10.99",
          "media_mail": false,
          "packaging": false,
          "length": "1.0",
          "width": "1.0",
          "height": "1.0",
          "active": true,
          "wholesale_cost": null,
          "is_bundle": false,
          "packaging_type": null,
          "promo": false,
          "street_date": null,
          "category": null,
          "include_inbound_in_published": false,
          "returnable": null,
          "return_sku_match": null,
          "return_price_restricted": null,
          "request_serial_number": null,
          "currency": "USD",
          "tariff_number": null,
          "label_format": null,
          "notify_originator_inventory": null,
          "name": "Test, It's a test book!",
          "image_url": null,
          "hazmat": true,
          "hazmat_type": "",
          "misc": null,
          "ean": null,
          "lot_control": false,
          "expiration_period": null,
          "ship_strategy": 0,
          "velocity": 0,
          "case_quantity": 1,
          "carton_quantity": null,
          "origin_country": null,
          "alcohol": false,
          "shippable_container": false,
          "replenishment_min": null,
          "replenishment_target": null,
          "low_inventory_threshold": null,
          "published_quantity": 100
        },
        "lot": null,
        "warehouse_id": 1,
        "unallocated": 0
      }
    ]
  },
  "fees": {},
  "event_name": "shipnotice.status_changed"
}

 

Back to top of Events

ShipnoticeItem.quantity_received

Fires when...
- The Shipnotice Item has been allocated to a location in the warehouse via a Shipnotice

{
  "shipnotice_item": {
    "id": 401975,
    "shipnotice_id": 176227,
    "item_id": 2467243,
    "quantity": 10,
    "quantity_good": 10,
    "quantity_damaged": 0,
    "description": null,
    "extended_description": null,
    "include_in_published": false,
    "return_action": null,
    "purchase_order_number": null,
    "created_at": "2022-02-25T16:48:36.000-05:00",
    "updated_at": "2022-02-25T17:02:32.000-05:00",
    "item": {
      "id": 2467243,
      "sku": "Eco-231-GG",
      "title": "The Economics of Banana Stickers",
      "description": "An insight into 8th grader bartering systems!",
      "full_description": "The Economics of Banana Stickers, An insight into 8th grader bartering systems!",
      "original_location": null,
      "created_at": "2022-02-25T16:41:07.000-05:00",
      "updated_at": "2022-02-25T17:08:32.000-05:00",
      "customer_id": 2779,
      "quantity": 10,
      "weight": "0.25",
      "available": true,
      "image_originator_url": "",
      "vendor": null,
      "scancode": "12-sl-20-05",
      "price": "24.99",
      "media_mail": false,
      "packaging": false,
      "length": "5.0",
      "width": "6.0",
      "height": "7.0",
      "active": true,
      "wholesale_cost": null,
      "is_bundle": false,
      "packaging_type": null,
      "promo": false,
      "street_date": null,
      "category": null,
      "include_inbound_in_published": false,
      "returnable": null,
      "return_sku_match": null,
      "return_price_restricted": null,
      "request_serial_number": null,
      "currency": "USD",
      "tariff_number": null,
      "label_format": null,
      "notify_originator_inventory": null,
      "name": "The Economics of Banana Stickers, An insight into 8th grader bartering systems!",
      "image_url": null,
      "hazmat": true,
      "hazmat_type": "",
      "misc": null,
      "ean": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 0,
      "velocity": 0,
      "case_quantity": null,
      "carton_quantity": null,
      "origin_country": null,
      "alcohol": false,
      "shippable_container": false,
      "replenishment_min": null,
      "replenishment_target": null,
      "low_inventory_threshold": null,
      "published_quantity": 10
    },
    "lot": null,
    "warehouse_id": 1,
    "unallocated": 0
  },
  "allocation": {
    "id": 411625,
    "quantity": 10,
    "created_at": "2022-02-25 17:08:32 -0500",
    "role": "pickable"
  },
  "transaction": {
    "id": 9099835,
    "item_id": 2467243,
    "order_id": null,
    "shipnotice_id": 176227,
    "user_id": 2932,
    "rule_id": null,
    "description": "Allocated Inventory from Mario , + 10",
    "quantity": 10,
    "change": 10,
    "created_at": "2022-02-25T17:08:32.000-05:00",
    "updated_at": "2022-02-25T17:08:32.000-05:00"
  },
  "event_name": "shipnotice_item.quantity_received"
}

 

Back to top of Events

Consumer Return Created

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

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

          ]
        }
      ],
      "packages": [

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

 

Back to top of Events

Consumer Return Deleted

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

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

          ]
        }
      ],
      "packages": [

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

 

Back to top of Events

Order Created

{
  "order": {
    "id": 2408444,
    "customer_id": 2780,
    "order_batch_id": null,
    "quote_id": null,
    "warehouse_id": 1,
    "return_warehouse_id": 1,
    "shipping_method_id": 37,
    "estimated_shipping_method_id": null,
    "humanize_id": "2408444",
    "status": 100,
    "status_name": "Processing",
    "previous_status": 100,
    "order_orig": "",
    "level1_token": "57c5b0755625c987c0ce53765a627412",
    "level2_token": "0c6c913dd89ad13301c45979193203b4",
    "workable_at": "2022-03-03T18:01:41.000-05:00",
    "skip_street_date": false,
    "due_at": "2022-03-04T16:00:00.000-05:00",
    "created_at": "2022-03-03T17:01:41.000-05:00",
    "updated_at": "2022-03-03T17:01:43.000-05:00",
    "meta_data": null,
    "customer_provided_label_carrier": null,
    "purchase_order": null,
    "order_type": "direct_to_consumer",
    "email": null,
    "address_verified": null,
    "items_updateable": true,
    "address_message": null,
    "shop_warehouse_ids": [],
    "shop_shipping_method_currency": null,
    "shop_created_at": null,
    "shop_updated_at": null,
    "shop_shipping_method_text": "",
    "shop_shipping_method_price": "0.0",
    "billing_company": "",
    "billing_address_1": "",
    "billing_address_2": "",
    "billing_address_3": "",
    "billing_city": "",
    "billing_state": "",
    "billing_zip": "",
    "billing_country": "",
    "billing_phone": "",
    "billed": false,
    "billing_name": "",
    "first_name": null,
    "last_name": null,
    "full_name": null,
    "shipping_name": "Alicia W",
    "shipping_company": "",
    "shipping_address_1": "123 Main st",
    "shipping_address_2": "",
    "shipping_city": "Holland",
    "shipping_state": "michigan",
    "shipping_zip": "49424",
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_phone": "",
    "requested_address": "123 Main st\nHolland, michigan 49424\nUnited States",
    "residential": true,
    "expedited": false,
    "require_signature": false,
    "require_adult_signature": false,
    "saturday_delivery": false,
    "gift": false,
    "insure": false,
    "contains_alcohol": false,
    "customs_required": false,
    "ship_actual_cost": null,
    "shipped_on": null,
    "ship_notes": null,
    "shipping_confirmation_sent": false,
    "ship_3rdparty_cost": "0.0",
    "ship_3rdparty_account": "",
    "ship_3rdparty_zip": "",
    "ship_3rdparty_country": "",
    "incoterm": null,
    "public_note": "",
    "days_in_transit": 1,
    "days_in_transit_carrier_estimate": null,
    "req_insurance_value": null,
    "ship_method": "Whiplash Cheapest Rate",
    "packingslip_pdf_url": null,
    "customs_vat_number": null,
    "customs_eori_number": null,
    "customs_ioss_number": null,
    "tracking": [],
    "tracking_links": [
      ""
    ],
    "approximate_delivery_date": null,
    "calculated_time_limit": 30,
    "within_return_time_limit": false,
    "return_name": null,
    "return_company": null,
    "return_address_1": null,
    "return_address_2": null,
    "return_city": null,
    "return_state": null,
    "return_country": null,
    "return_zip": null,
    "return_phone": null,
    "return_email": null,
    "return_address_verified": null,
    "return_time_limit": null,
    "is_workable": false,
    "is_gestating": true,
    "permissions_limited": false,
    "order_items": [],
    "originator": {
      "id": 11299344,
      "originated_id": 2408444,
      "originated_type": "Order",
      "shop_id": null,
      "provider": "whiplash",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-03T17:01:41.000-05:00",
      "updated_at": "2022-03-03T17:01:41.000-05:00",
      "application_id": null
    },
    "proto_originator_id": null,
    "packages": [
      {
        "id": 2398463,
        "order_id": 2408444,
        "shipped_on": null,
        "ship_actual_cost": null,
        "actual_weight": null,
        "actual_width": null,
        "actual_height": null,
        "actual_length": null,
        "actual_dimensional_weight": null,
        "tracking": null,
        "tracking_link": "",
        "order_item_ids": [],
        "created_at": "2022-03-03T17:01:41.000-05:00",
        "updated_at": "2022-03-03T17:01:41.000-05:00",
        "ucc128": null,
        "ship_actual_currency": null,
        "vics_bill_of_lading": "0023984636",
        "manifest_id": null
      }
    ],
    "shipping_method": {
      "id": 37,
      "carrier": "Whiplash",
      "service": "cheapest",
      "description": "Cheapest Rate",
      "name": "Whiplash Cheapest Rate",
      "international": false,
      "active": true,
      "flat_rate": false,
      "expedited": false,
      "trackable": true,
      "origins": [
        "US",
        "GB"
      ],
      "extended_description": null,
      "created_at": "2014-11-19T15:53:32.000-05:00",
      "updated_at": "2015-08-03T16:23:10.000-04:00"
    },
    "serial_numbers": []
  },
  "fees": {},
  "tracking_details": [],
  "event_name": "order.created"
}
 

 

Back to top of Events

Order Delivered

{
  "event_name": "order.delivered",
  "order": {
    "billed": false,
    "created_at": "2015-03-11T07:50:33Z",
    "days_in_transit": 1,
    "email": "whiplash@whiplashmerch.com",
    "gift": false,
    "id": 1234567,
    "reference": "54321",
    "insure": false,
    "originator_notified": true,
    "pack_fee_actual": null,
    "packaging_fee_actual": null,
    "pick_fee_actual": null,
    "public_note": null,
    "require_signature": false,
    "ship_3rdparty_cost": 0.0,
    "ship_actual_cost": 5.95,
    "ship_notes": null,
    "shipped_on": "2015-03-11T13:50:22Z",
    "shipping_address_1": "1334 San Mateo Avenue",
    "shipping_address_2": "",
    "shipping_city": "South San Francisco",
    "shipping_company": null,
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_name": "James Hetfield",
    "shipping_phone": "1231234567",
    "shipping_state": "CA",
    "shipping_zip": 94080,
    "shop_shipping_method_price": 8.85,
    "shop_shipping_method_text": "USPS Priority Mail 2-Day",
    "shop_shipping_method_currency": "USD",
    "shop_created_at": "2015-03-11T07:50:33Z",
    "shop_updated_at": "2015-03-11T07:50:33Z",
    "shop_warehouse_id": 1,
    "status": 350,
    "total_fee_actual": null,
    "tracking_sent": true,
    "updated_at": "2015-03-11T13:50:27Z",
    "fees": {
      "pick": 0.25,
      "pack": 2.95,
      "packaging": 0.0,
      "postage": 5.34,
      "total": 8.63
    },
    "tracking": [
      "911111111111111111111"
    ],
    "originator_id": "54321",
    "provider": "example_provider",
    "monetary_value": 100.0,
    "insurance_value": 100.18,
    "ship_method": "USPS Priority Mail",
    "status_name": "Delivered",
    "order_items": [
      {
        "available": true,
        "created_at": "2015-03-11T07:50:33Z",
        "description": "Test Item LP",
        "id": 1111,
        "item_id": 12345,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 70.0,
        "quantity": 1,
        "sku": "TI-LP",
        "updated_at": "2015-03-11T07:50:34Z",
        "originator_id": "76543",
        "provider": "example_provider",
        "serialnumbers": [
          111222333
        ]
      },
      {
        "available": true,
        "created_at": "2015-03-11T07:50:33Z",
        "description": "Test Item T-Shirt, Small",
        "id": 1112,
        "item_id": 123567,
        "order_id": 1234567,
        "package_id": 2222,
        "packaging": false,
        "packed": 1,
        "price": 49.5,
        "quantity": 1,
        "sku": "TI-Shirt-S",
        "updated_at": "2015-03-11T13:48:59Z",
        "originator_id": "76522",
        "provider": "example_provider",
        "serialnumbers": [
          22223333444
        ]
      }
    ],
    "packages": [
      {
        "tracking": "1ZE190000000000000",
        "shipped_on": "2015-03-11T13:50:27Z",
        "bill_of_lading": null,
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T13:50:27Z",
        "pick_fee": 0.0,
        "pack_fee": 2.95,
        "packaging_fee": 3.17,
        "weight": 621.0,
        "shipping_cost": 28.48,
        "packaging_type": "Parcel",
        "order_item_ids": [
          1233,
          1234
        ]
      },
      {
        "tracking": "1ZE190860000000000",
        "shipped_on": "2015-03-11T13:50:27Z",
        "bill_of_lading": 234234234234,
        "created_at": "2015-03-11T07:50:33Z",
        "updated_at": "2015-03-11T13:50:27Z",
        "pick_fee": 0.0,
        "pack_fee": 2.95,
        "packaging_fee": 3.17,
        "weight": 121.0,
        "shipping_cost": 8.48,
        "packaging_type": "Parcel",
        "order_item_ids": [
          1245,
          4321
        ]
      }
    ]
  },
  "tracking_details": [
    {
      "created_at": "2015-03-14T13:50:27Z",
      "description": "THE RECEIVER WAS NOT AVAILABLE AT THE TIME OF THE FIRST DELIVERY ATTEMPT. A SECOND ATTEMPT WILL BE MADE.",
      "status": "in_transit"
    },
    {
      "created_at": "2015-03-15T13:50:27Z",
      "description": "Delivered, In/At Mailbox in TACOMA, WA",
      "status": "delivered"
    }
  ]
}
    

 

Back to top of Events

Order Status Changed

Payload when an order is in Processing status:

{
"order": {
"shipping_company": null,
"shipping_method_id": null,
"customer_id": 3545,
"shipping_address_1": "54295 O'Connell Lakes",
"shipping_address_2": null,
"shipping_city": "South Claritaton",
"shipping_state": "Georgia",
"shipping_zip": "46735",
"shipping_country": "United States",
"shipping_country_iso2": "US",
"shipping_phone": null,
"email": "williehane@borer.co",
"ship_notes": null,
"shipping_name": "Joanne Mraz",
"shop_shipping_method_text": null,
"shop_shipping_method_price": "0.0",
"shop_shipping_method_currency": null,
"shop_warehouse_ids": [],
"public_note": null,
"gift": false,
"insure": false,
"require_signature": false,
"saturday_delivery": false,
"shop_created_at": null,
"shop_updated_at": null,
"reference": "KA11982",
"return_city": null,
"return_state": null,
"return_country": null,
"return_zip": null,
"return_address_1": null,
"return_address_2": null,
"return_phone": null,
"return_email": null,
"return_company": null,
"return_name": null,
"require_adult_signature": false,
"contains_alcohol": false,
"ship_3rdparty_zip": null,
"ship_3rdparty_country": null,
"ship_3rdparty_account": null,
"incoterm": null,
"billing_name": null,
"billing_company": null,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_zip": null,
"billing_country": null,
"billing_phone": null,
"days_in_transit": 1,
"meta_data": null,
"packingslip_pdf_url": null,
"estimated_shipping_method_id": null,
"id": 2650031,
"billed": false,
"created_at": "2020-09-16 17:03:17 -0400",
"days_in_transit_carrier_estimate": null,
"ship_3rdparty_cost": "0.0",
"ship_actual_cost": null,
"shipped_on": null,
"status": 100,
"shipping_confirmation_sent": false,
"updated_at": "2020-09-16 17:03:17 -0400",
"level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
"level2_token": "25ba76e38a12056440d59f4251a17154",
"warehouse_id": 1,
"return_warehouse_id": 1,
"address_verified": true,
"address_message": null,
"skip_address_verification": false,
"carrier_account_id": null,
"customer_provided_label_carrier": null,
"residential": true,
"originator_notified": false,
"ship_method": null,
"tracking": [],
"tracking_links": [
""
],
"approximate_delivery_date": null,
"originator_id": null,
"originator_group_id": null,
"proto_originator_id": null,
"provider": "whiplash",
"insurance_value": 0,
"monetary_value": 0,
"status_name": "Processing",
"order_items": [
{
"id": 6327196,
"order_id": 2650031,
"sku": "OAJJ-0004",
"description": "Orchid Atlantis Jean Jacket, Size 4",
"quantity": 1,
"packed": 0,
"price": "0.0",
"wholesale_cost": null,
"item_id": 1244320,
"available": false,
"returnable": null,
"packaging": false,
"originator_id": null,
"currency": "USD",
"hazmat": false,
"misc": null,
"originator": {
"original_id": null,
"group_id": null,
"provider": "whiplash"
},
"serial_numbers": [],
"lots": []
}
],
"packages": []
},
"fees": {},
"tracking_details": [],
"event_name": "order.status_changed"
}

 

Payload when an order is in Insufficient Inventory status:

{
  "order": {
    "id": 2410547,
    "customer_id": 2780,
    "order_batch_id": null,
    "quote_id": null,
    "warehouse_id": 1,
    "return_warehouse_id": 1,
    "shipping_method_id": 37,
    "estimated_shipping_method_id": null,
    "humanize_id": "2410547",
    "status": 95,
    "status_name": "Insufficient Inventory",
    "previous_status": 100,
    "order_orig": "",
    "level1_token": "8557040324add01b704ac9f0571c28c4",
    "level2_token": "357adf1dc5d27051a8f43ddd99d858f4",
    "workable_at": null,
    "skip_street_date": false,
    "due_at": null,
    "created_at": "2022-03-11T15:32:51.000-05:00",
    "updated_at": "2022-03-11T15:33:21.000-05:00",
    "meta_data": null,
    "customer_provided_label_carrier": null,
    "purchase_order": null,
    "order_type": "direct_to_consumer",
    "email": null,
    "address_verified": null,
    "items_updateable": true,
    "address_message": null,
    "shop_warehouse_ids": [],
    "shop_shipping_method_currency": null,
    "shop_created_at": null,
    "shop_updated_at": null,
    "shop_shipping_method_text": "",
    "shop_shipping_method_price": "0.0",
    "billing_company": "",
    "billing_address_1": "",
    "billing_address_2": "",
    "billing_address_3": "",
    "billing_city": "",
    "billing_state": "",
    "billing_zip": "",
    "billing_country": "",
    "billing_phone": "",
    "billed": false,
    "billing_name": "",
    "first_name": null,
    "last_name": null,
    "full_name": null,
    "shipping_name": "Alicia Weenum",
    "shipping_company": "",
    "shipping_address_1": "123 New Order way",
    "shipping_address_2": "",
    "shipping_city": "Chino",
    "shipping_state": "CA",
    "shipping_zip": "12345",
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_phone": "",
    "requested_address": "123 New Order way\nChino, CA 12345\nUnited States",
    "residential": true,
    "expedited": false,
    "require_signature": false,
    "require_adult_signature": false,
    "saturday_delivery": false,
    "gift": false,
    "insure": false,
    "contains_alcohol": false,
    "customs_required": false,
    "ship_actual_cost": null,
    "shipped_on": null,
    "ship_notes": null,
    "shipping_confirmation_sent": false,
    "ship_3rdparty_cost": "0.0",
    "ship_3rdparty_account": "",
    "ship_3rdparty_zip": "",
    "ship_3rdparty_country": "",
    "incoterm": null,
    "public_note": "",
    "days_in_transit": 1,
    "days_in_transit_carrier_estimate": null,
    "req_insurance_value": null,
    "ship_method": "Whiplash Cheapest Rate",
    "packingslip_pdf_url": null,
    "customs_vat_number": null,
    "customs_eori_number": null,
    "customs_ioss_number": null,
    "tracking": [],
    "tracking_links": [
      ""
    ],
    "approximate_delivery_date": null,
    "calculated_time_limit": 30,
    "within_return_time_limit": false,
    "return_name": null,
    "return_company": null,
    "return_address_1": null,
    "return_address_2": null,
    "return_city": null,
    "return_state": null,
    "return_country": null,
    "return_zip": null,
    "return_phone": null,
    "return_email": null,
    "return_address_verified": null,
    "return_time_limit": null,
    "is_workable": true,
    "is_gestating": null,
    "permissions_limited": false,
    "order_items": [
      {
        "id": 5870342,
        "order_id": 2410547,
        "customer_id": 2780,
        "item_id": 2469719,
        "package_id": 2400554,
        "quote_item_id": null,
        "sku": "222-aaa-ss",
        "description": "More apples, More apples",
        "quantity": 2000,
        "price": "14.99",
        "created_at": "2022-03-11T15:33:04.000-05:00",
        "updated_at": "2022-03-11T15:33:04.000-05:00",
        "unshippable": false,
        "available": true,
        "packed": 0,
        "packaging": false,
        "wholesale_cost": null,
        "is_bundle": false,
        "retail_fee": null,
        "promo": false,
        "returnable": null,
        "currency": "USD",
        "wholesale_fee": null,
        "hazmat": true,
        "misc": null,
        "request_serial_number": false,
        "originator": {
          "id": 11310200,
          "originated_id": 5870342,
          "originated_type": "OrderItem",
          "shop_id": null,
          "provider": "whiplash",
          "original_id": null,
          "group_id": null,
          "misc": null,
          "active": true,
          "integration_id": null,
          "last_notified_at": null,
          "last_notification_status": null,
          "distinct_originator_key": null,
          "created_at": "2022-03-11T15:33:04.000-05:00",
          "updated_at": "2022-03-11T15:33:04.000-05:00",
          "application_id": null
        }
      }
    ],
    "originator": {
      "id": 11310199,
      "originated_id": 2410547,
      "originated_type": "Order",
      "shop_id": null,
      "provider": "whiplash",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-11T15:32:51.000-05:00",
      "updated_at": "2022-03-11T15:32:51.000-05:00",
      "application_id": null
    },
    "proto_originator_id": null,
    "packages": [
      {
        "id": 2400554,
        "order_id": 2410547,
        "shipped_on": null,
        "ship_actual_cost": null,
        "actual_weight": null,
        "actual_width": null,
        "actual_height": null,
        "actual_length": null,
        "actual_dimensional_weight": null,
        "tracking": null,
        "tracking_link": "",
        "order_item_ids": [
          5870342
        ],
        "created_at": "2022-03-11T15:32:51.000-05:00",
        "updated_at": "2022-03-11T15:32:51.000-05:00",
        "ucc128": null,
        "ship_actual_currency": null,
        "vics_bill_of_lading": "0024005548",
        "manifest_id": null
      }
    ],
    "shipping_method": {
      "id": 37,
      "carrier": "Whiplash",
      "service": "cheapest",
      "description": "Cheapest Rate",
      "name": "Whiplash Cheapest Rate",
      "international": false,
      "active": true,
      "flat_rate": false,
      "expedited": false,
      "trackable": true,
      "origins": [
        "US",
        "GB"
      ],
      "extended_description": null,
      "created_at": "2014-11-19T15:53:32.000-05:00",
      "updated_at": "2015-08-03T16:23:10.000-04:00"
    },
    "serial_numbers": []
  },
  "fees": {},
  "tracking_details": [],
  "event_name": "order.status_changed"
}
 
Payload when an order is in Paused status:
{
  "order": {
    "id": 2410547,
    "customer_id": 2780,
    "order_batch_id": null,
    "quote_id": null,
    "warehouse_id": 1,
    "return_warehouse_id": 1,
    "shipping_method_id": 37,
    "estimated_shipping_method_id": null,
    "humanize_id": "2410547",
    "status": 40,
    "status_name": "Cancelled",
    "previous_status": 95,
    "order_orig": "",
    "level1_token": "8557040324add01b704ac9f0571c28c4",
    "level2_token": "357adf1dc5d27051a8f43ddd99d858f4",
    "workable_at": null,
    "skip_street_date": false,
    "due_at": null,
    "created_at": "2022-03-11T15:32:51.000-05:00",
    "updated_at": "2022-03-11T15:43:15.000-05:00",
    "meta_data": null,
    "customer_provided_label_carrier": null,
    "purchase_order": null,
    "order_type": "direct_to_consumer",
    "email": null,
    "address_verified": null,
    "items_updateable": false,
    "address_message": null,
    "shop_warehouse_ids": [],
    "shop_shipping_method_currency": null,
    "shop_created_at": null,
    "shop_updated_at": null,
    "shop_shipping_method_text": "",
    "shop_shipping_method_price": "0.0",
    "billing_company": "",
    "billing_address_1": "",
    "billing_address_2": "",
    "billing_address_3": "",
    "billing_city": "",
    "billing_state": "",
    "billing_zip": "",
    "billing_country": "",
    "billing_phone": "",
    "billed": false,
    "billing_name": "",
    "first_name": null,
    "last_name": null,
    "full_name": null,
    "shipping_name": "Alicia Weenum",
    "shipping_company": "",
    "shipping_address_1": "123 New Order way",
    "shipping_address_2": "",
    "shipping_city": "Chino",
    "shipping_state": "CA",
    "shipping_zip": "12345",
    "shipping_country": "United States",
    "shipping_country_iso2": "US",
    "shipping_phone": "",
    "requested_address": "123 New Order way\nChino, CA 12345\nUnited States",
    "residential": true,
    "expedited": false,
    "require_signature": false,
    "require_adult_signature": false,
    "saturday_delivery": false,
    "gift": false,
    "insure": false,
    "contains_alcohol": false,
    "customs_required": false,
    "ship_actual_cost": null,
    "shipped_on": null,
    "ship_notes": null,
    "shipping_confirmation_sent": false,
    "ship_3rdparty_cost": "0.0",
    "ship_3rdparty_account": "",
    "ship_3rdparty_zip": "",
    "ship_3rdparty_country": "",
    "incoterm": null,
    "public_note": "",
    "days_in_transit": 1,
    "days_in_transit_carrier_estimate": null,
    "req_insurance_value": null,
    "ship_method": "Whiplash Cheapest Rate",
    "packingslip_pdf_url": null,
    "customs_vat_number": null,
    "customs_eori_number": null,
    "customs_ioss_number": null,
    "tracking": [],
    "tracking_links": [
      ""
    ],
    "approximate_delivery_date": null,
    "calculated_time_limit": 30,
    "within_return_time_limit": false,
    "return_name": null,
    "return_company": null,
    "return_address_1": null,
    "return_address_2": null,
    "return_city": null,
    "return_state": null,
    "return_country": null,
    "return_zip": null,
    "return_phone": null,
    "return_email": null,
    "return_address_verified": null,
    "return_time_limit": null,
    "is_workable": true,
    "is_gestating": null,
    "permissions_limited": false,
    "order_items": [
      {
        "id": 5870342,
        "order_id": 2410547,
        "customer_id": 2780,
        "item_id": 2469719,
        "package_id": 2400554,
        "quote_item_id": null,
        "sku": "222-aaa-ss",
        "description": "More apples, More apples",
        "quantity": 2000,
        "price": "14.99",
        "created_at": "2022-03-11T15:33:04.000-05:00",
        "updated_at": "2022-03-11T15:33:04.000-05:00",
        "unshippable": false,
        "available": true,
        "packed": 0,
        "packaging": false,
        "wholesale_cost": null,
        "is_bundle": false,
        "retail_fee": null,
        "promo": false,
        "returnable": null,
        "currency": "USD",
        "wholesale_fee": null,
        "hazmat": true,
        "misc": null,
        "request_serial_number": false,
        "originator": {
          "id": 11310200,
          "originated_id": 5870342,
          "originated_type": "OrderItem",
          "shop_id": null,
          "provider": "whiplash",
          "original_id": null,
          "group_id": null,
          "misc": null,
          "active": true,
          "integration_id": null,
          "last_notified_at": null,
          "last_notification_status": null,
          "distinct_originator_key": null,
          "created_at": "2022-03-11T15:33:04.000-05:00",
          "updated_at": "2022-03-11T15:33:04.000-05:00",
          "application_id": null
        }
      }
    ],
    "originator": {
      "id": 11310199,
      "originated_id": 2410547,
      "originated_type": "Order",
      "shop_id": null,
      "provider": "whiplash",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-11T15:32:51.000-05:00",
      "updated_at": "2022-03-11T15:32:51.000-05:00",
      "application_id": null
    },
    "proto_originator_id": null,
    "packages": [
      {
        "id": 2400554,
        "order_id": 2410547,
        "shipped_on": null,
        "ship_actual_cost": null,
        "actual_weight": null,
        "actual_width": null,
        "actual_height": null,
        "actual_length": null,
        "actual_dimensional_weight": null,
        "tracking": null,
        "tracking_link": "",
        "order_item_ids": [
          5870342
        ],
        "created_at": "2022-03-11T15:32:51.000-05:00",
        "updated_at": "2022-03-11T15:32:51.000-05:00",
        "ucc128": null,
        "ship_actual_currency": null,
        "vics_bill_of_lading": "0024005548",
        "manifest_id": null
      }
    ],
    "shipping_method": {
      "id": 37,
      "carrier": "Whiplash",
      "service": "cheapest",
      "description": "Cheapest Rate",
      "name": "Whiplash Cheapest Rate",
      "international": false,
      "active": true,
      "flat_rate": false,
      "expedited": false,
      "trackable": true,
      "origins": [
        "US",
        "GB"
      ],
      "extended_description": null,
      "created_at": "2014-11-19T15:53:32.000-05:00",
      "updated_at": "2015-08-03T16:23:10.000-04:00"
    },
    "serial_numbers": []
  },
  "fees": {},
  "tracking_details": [],
  "event_name": "order.status_changed"
}

 

Back to top of Events

Order Insufficient Inventory

{
"order": {
"shipping_company": null,
"shipping_method_id": null,
"customer_id": 3545,
"shipping_address_1": "54295 O'Connell Lakes",
"shipping_address_2": null,
"shipping_city": "South Claritaton",
"shipping_state": "Georgia",
"shipping_zip": "46735",
"shipping_country": "United States",
"shipping_country_iso2": "US",
"shipping_phone": null,
"email": "williehane@borer.co",
"ship_notes": null,
"shipping_name": "Joanne Mraz",
"shop_shipping_method_text": null,
"shop_shipping_method_price": "0.0",
"shop_shipping_method_currency": null,
"shop_warehouse_ids": [],
"public_note": null,
"gift": false,
"insure": false,
"require_signature": false,
"saturday_delivery": false,
"shop_created_at": null,
"shop_updated_at": null,
"reference": "KA11982",
"return_city": null,
"return_state": null,
"return_country": null,
"return_zip": null,
"return_address_1": null,
"return_address_2": null,
"return_phone": null,
"return_email": null,
"return_company": null,
"return_name": null,
"require_adult_signature": false,
"contains_alcohol": false,
"ship_3rdparty_zip": null,
"ship_3rdparty_country": null,
"ship_3rdparty_account": null,
"incoterm": null,
"billing_name": null,
"billing_company": null,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_zip": null,
"billing_country": null,
"billing_phone": null,
"days_in_transit": 1,
"meta_data": null,
"packingslip_pdf_url": null,
"estimated_shipping_method_id": null,
"id": 2650031,
"billed": false,
"created_at": "2020-09-16 17:03:17 -0400",
"days_in_transit_carrier_estimate": null,
"ship_3rdparty_cost": "0.0",
"ship_actual_cost": null,
"shipped_on": null,
"status": 95,
"shipping_confirmation_sent": false,
"updated_at": "2020-09-16 17:03:17 -0400",
"level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
"level2_token": "25ba76e38a12056440d59f4251a17154",
"warehouse_id": 1,
"return_warehouse_id": 1,
"address_verified": true,
"address_message": null,
"skip_address_verification": false,
"carrier_account_id": null,
"customer_provided_label_carrier": null,
"residential": true,
"originator_notified": false,
"ship_method": null,
"tracking": [],
"tracking_links": [
""
],
"approximate_delivery_date": null,
"originator_id": null,
"originator_group_id": null,
"proto_originator_id": null,
"provider": "whiplash",
"insurance_value": 0,
"monetary_value": 0,
"status_name": "Insufficient Inventory",
"order_items": [
{
"id": 6327196,
"order_id": 2650031,
"sku": "OAJJ-0004",
"description": "Orchid Atlantis Jean Jacket, Size 4",
"quantity": 1,
"packed": 0,
"price": "0.0",
"wholesale_cost": null,
"item_id": 1244320,
"available": false,
"returnable": null,
"packaging": false,
"originator_id": null,
"currency": "USD",
"hazmat": false,
"misc": null,
"originator": {
"original_id": null,
"group_id": null,
"provider": "whiplash"
},
"serial_numbers": [],
"lots": []
}
],
"packages": []
},
"fees": {},
"tracking_details": [],
"event_name": "order.insufficient_inventory"
}

 

Back to top of Events

Order Cancelled

{
"order": {
"id": 2405029,
"customer_id": 2780,
"order_batch_id": null,
"quote_id": null,
"warehouse_id": 1,
"return_warehouse_id": 1,
"shipping_method_id": 37,
"estimated_shipping_method_id": null,
"humanize_id": "2405029",
"status": 40,
"status_name": "Cancelled",
"previous_status": 100,
"order_orig": "",
"level1_token": "0f62f4e888241546a18c3f4e6c70a61d",
"level2_token": "39ead092927d7d1619804e81b12c1761",
"workable_at": null,
"skip_street_date": false,
"due_at": null,
"created_at": "2022-02-25T17:06:07.000-05:00",
"updated_at": "2022-02-25T17:06:23.000-05:00",
"meta_data": null,
"customer_provided_label_carrier": null,
"purchase_order": null,
"order_type": "direct_to_consumer",
"email": null,
"address_verified": null,
"items_updateable": false,
"address_message": null,
"shop_warehouse_ids": [],
"shop_shipping_method_currency": null,
"shop_created_at": null,
"shop_updated_at": null,
"shop_shipping_method_text": "",
"shop_shipping_method_price": "0.0",
"billing_company": "",
"billing_address_1": "",
"billing_address_2": "",
"billing_address_3": "",
"billing_city": "",
"billing_state": "",
"billing_zip": "",
"billing_country": "",
"billing_phone": "",
"billed": false,
"billing_name": "",
"first_name": null,
"last_name": null,
"full_name": null,
"shipping_name": "Jane Smith",
"shipping_company": "",
"shipping_address_1": "123 Main st",
"shipping_address_2": "",
"shipping_city": "St Augustine",
"shipping_state": "Fl",
"shipping_zip": "32084",
"shipping_country": "United States",
"shipping_country_iso2": "US",
"shipping_phone": "123-234-3456",
"requested_address": "123 Main st\nSt Augustine, Fl 32084\nUnited States",
"residential": true,
"expedited": false,
"require_signature": false,
"require_adult_signature": false,
"saturday_delivery": false,
"gift": false,
"insure": false,
"contains_alcohol": false,
"customs_required": false,
"ship_actual_cost": null,
"shipped_on": null,
"ship_notes": null,
"shipping_confirmation_sent": false,
"ship_3rdparty_cost": "0.0",
"ship_3rdparty_account": "",
"ship_3rdparty_zip": "",
"ship_3rdparty_country": "",
"incoterm": null,
"public_note": "",
"days_in_transit": 1,
"days_in_transit_carrier_estimate": null,
"req_insurance_value": null,
"ship_method": "Whiplash Cheapest Rate",
"packingslip_pdf_url": null,
"customs_vat_number": null,
"customs_eori_number": null,
"customs_ioss_number": null,
"tracking": [],
"tracking_links": [
""
],
"approximate_delivery_date": null,
"calculated_time_limit": 30,
"within_return_time_limit": false,
"return_name": null,
"return_company": null,
"return_address_1": null,
"return_address_2": null,
"return_city": null,
"return_state": null,
"return_country": null,
"return_zip": null,
"return_phone": null,
"return_email": null,
"return_address_verified": null,
"return_time_limit": null,
"is_workable": true,
"is_gestating": null,
"permissions_limited": false,
"order_items": [
{
"id": 5862661,
"order_id": 2405029,
"customer_id": 2780,
"item_id": 2467244,
"package_id": 2394950,
"quote_item_id": null,
"sku": "123-app-le",
"description": "Honey Crisp, Honey crisp apple",
"quantity": 1,
"price": "5.99",
"created_at": "2022-02-25T17:06:14.000-05:00",
"updated_at": "2022-02-25T17:06:14.000-05:00",
"unshippable": false,
"available": true,
"packed": 0,
"packaging": false,
"wholesale_cost": null,
"is_bundle": false,
"retail_fee": null,
"promo": false,
"returnable": null,
"currency": "USD",
"wholesale_fee": null,
"hazmat": true,
"misc": null,
"request_serial_number": false,
"originator": {
"id": 11289126,
"originated_id": 5862661,
"originated_type": "OrderItem",
"shop_id": null,
"provider": "whiplash",
"original_id": null,
"group_id": null,
"misc": null,
"active": true,
"integration_id": null,
"last_notified_at": null,
"last_notification_status": null,
"distinct_originator_key": null,
"created_at": "2022-02-25T17:06:15.000-05:00",
"updated_at": "2022-02-25T17:06:15.000-05:00",
"application_id": null
}
}
],
"originator": {
"id": 11289125,
"originated_id": 2405029,
"originated_type": "Order",
"shop_id": null,
"provider": "whiplash",
"original_id": null,
"group_id": null,
"misc": null,
"active": true,
"integration_id": null,
"last_notified_at": null,
"last_notification_status": null,
"distinct_originator_key": null,
"created_at": "2022-02-25T17:06:07.000-05:00",
"updated_at": "2022-02-25T17:06:07.000-05:00",
"application_id": null
},
"proto_originator_id": null,
"packages": [
{
"id": 2394950,
"order_id": 2405029,
"shipped_on": null,
"ship_actual_cost": null,
"actual_weight": null,
"actual_width": null,
"actual_height": null,
"actual_length": null,
"actual_dimensional_weight": null,
"tracking": null,
"tracking_link": "",
"order_item_ids": [
5862661
],
"created_at": "2022-02-25T17:06:07.000-05:00",
"updated_at": "2022-02-25T17:06:07.000-05:00",
"ucc128": null,
"ship_actual_currency": null,
"vics_bill_of_lading": "0023949506",
"manifest_id": null
}
],
"shipping_method": {
"id": 37,
"carrier": "Whiplash",
"service": "cheapest",
"description": "Cheapest Rate",
"name": "Whiplash Cheapest Rate",
"international": false,
"active": true,
"flat_rate": false,
"expedited": false,
"trackable": true,
"origins": [
"US",
"GB"
],
"extended_description": null,
"created_at": "2014-11-19T15:53:32.000-05:00",
"updated_at": "2015-08-03T16:23:10.000-04:00"
},
"serial_numbers": []
},
"fees": {},
"tracking_details": [],
"event_name": "order.cancelled"
}

 

Back to top of Events

Consumer Return Status Changed

Payload of a return in Processing status:

{
  "consumer_return": {
    "id": 176380,
    "order_id": 2408144,
    "customer_id": 2779,
    "warehouse_id": 1,
    "sender": "William Tell",
    "eta": "2022-03-23T16:21:11.000-04:00",
    "status": 200,
    "status_name": "Processing",
    "received_by": "2932",
    "notes_by_whiplash": "",
    "notes_by_customer": null,
    "total_boxes": 1,
    "created_at": "2022-03-09T15:21:11.000-05:00",
    "updated_at": "2022-03-09T15:58:18.000-05:00",
    "arrived_at": "2022-03-09T15:45:04.000-05:00",
    "skip_images": null,
    "easypostable_id": null,
    "easypostable_type": "Shipment",
    "shipping_label_url": null,
    "ship_actual_cost": null,
    "shipping_method_text": null,
    "carrier": null,
    "tracking": null,
    "type": "ConsumerReturn",
    "postage_billed": null,
    "handling_billed": true,
    "ship_3rdparty_cost": null,
    "requires_label": true,
    "completed_at": null,
    "ship_actual_currency": null,
    "delivered_at": "2022-03-09T15:45:04.000-05:00",
    "due_at": "2022-03-14T16:00:00.000-04:00",
    "reference": null,
    "customer": {
      "id": 2779,
      "name": "Joey's Books",
      "created_at": "2022-02-25T16:17:45.000-05:00",
      "active": true,
      "auto_merge_gestation": null,
      "default_warehouse_id": 1,
      "eori_number": null,
      "estimated_monthly_volume": null,
      "fedex_account": null,
      "from_email": null,
      "instructions": null,
      "item_scanning_preference": true,
      "label_format": null,
      "notes": null,
      "notify_originator": true,
      "notify_originator_inventory": 2,
      "originator_permissions": false,
      "packing_slip_msg": null,
      "packingslip_template": null,
      "request_serial_numbers": false,
      "ship_method_preference": 0,
      "shipping_name": "Joey's Books",
      "ups_account": null,
      "vat_number": null,
      "ein": null,
      "warehouse_fallback": 0,
      "payment_hold": false,
      "whitelisted_warehouses": [
        {
          "id": 1,
          "name": "Ann Arbor",
          "timezone": "Eastern Time (US & Canada)",
          "timezone_raw": "America/New_York",
          "shipping_address_1": "4657 Platt Road",
          "shipping_address_2": "",
          "shipping_city": "Ann Arbor",
          "shipping_state": "Michigan",
          "shipping_zip": "48108",
          "shipping_country": "United States",
          "shipping_country_iso2": "US",
          "latitude": 42.2206,
          "longitude": -83.6989,
          "slug": "ann-arbor"
        }
      ],
      "allowed_warehouse_ids": [
        1
      ],
      "account_level": 200,
      "account_level_name": null,
      "activated_at": "2022-02-25T16:18:12.000-05:00",
      "deactivated_at": null,
      "auto_merge_skus": false,
      "billing_email": "Joe.Bookman@joeysbooks.com",
      "billing_contact_name": "Joe Bookman",
      "billing_company": null,
      "billing_phone1": "212-212-1212",
      "billing_phone2": null,
      "billing_address1": null,
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": null,
      "billing_state": null,
      "billing_zip": null,
      "billing_country": "US",
      "billing_residential": null,
      "items_returnable": true,
      "allow_international_returns": true,
      "items_exchangeable": true,
      "return_time_limit": 30,
      "return_label_expires_in": 29,
      "return_price_restricted": true,
      "return_sku_match": null,
      "rma_display_logo": true,
      "rma_footer_content": null,
      "return_name": null,
      "return_company": null,
      "return_email": null,
      "return_phone": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_zip": null,
      "return_country": null,
      "supports_return_labels": true,
      "logo_content_type": null,
      "logo_file_name": null,
      "logo_file_size": null,
      "logo_updated_at": null,
      "full_logo_url": "",
      "email_confirmation_from": "Joe.Bookman@joeysbooks.com",
      "email_confirmation_name": "Joe Bookman",
      "email_confirmation_msg": null,
      "email_confirmation_preference": 0,
      "email_confirmation_template": null,
      "low_inventory_threshold": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 1,
      "items_unavailable_on_sellout": 1,
      "replenishment_min": null,
      "replenishment_target": null,
      "location_default_return_role": "pickable",
      "location_enable_pending_returns": false
    },
    "warehouse": {
      "id": 1,
      "name": "Ann Arbor",
      "timezone": "Eastern Time (US & Canada)",
      "timezone_raw": "America/New_York",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": "",
      "shipping_city": "Ann Arbor",
      "shipping_state": "Michigan",
      "shipping_zip": "48108",
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "latitude": 42.2206,
      "longitude": -83.6989,
      "slug": "ann-arbor"
    },
    "originator": {
      "id": 11304402,
      "originated_id": 176380,
      "originated_type": "Shipnotice",
      "shop_id": null,
      "provider": "whiplash",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-09T15:21:11.000-05:00",
      "updated_at": "2022-03-09T15:21:11.000-05:00",
      "application_id": null
    },
    "return_items": [
      {
        "id": 402345,
        "item_id": 2467445,
        "name": "Dim candles in the night, 10 chilling ghost stories for non-believers",
        "sku": "Horr-BOO-12",
        "price": "19.99",
        "quantity": 3,
        "quantity_good": 3,
        "quantity_damaged": 0,
        "description": "Item not as expected: 3",
        "extended_description": "",
        "return_action": "refund: 3",
        "order_item_id": 5866169,
        "return_item_originator_id": null,
        "originator_id": null,
        "lot_ids": [
          null
        ]
      }
    ],
    "exchange_order": null,
    "order": {
      "id": 2408144,
      "customer_id": 2779,
      "order_batch_id": 119173,
      "quote_id": null,
      "warehouse_id": 1,
      "return_warehouse_id": 1,
      "shipping_method_id": 37,
      "estimated_shipping_method_id": null,
      "humanize_id": "2408144",
      "status": 450,
      "status_name": "Refund Requested",
      "previous_status": 300,
      "order_orig": "",
      "level1_token": "9fb99ee0be70676aa1eccac0a93a4387",
      "level2_token": "1fb53b7318a31a3dc5ed9c118f99f146",
      "workable_at": "2022-03-01T16:35:00.000-05:00",
      "skip_street_date": false,
      "due_at": "2022-03-02T16:00:00.000-05:00",
      "created_at": "2022-03-01T16:34:34.000-05:00",
      "updated_at": "2022-03-09T15:21:11.000-05:00",
      "meta_data": null,
      "customer_provided_label_carrier": null,
      "purchase_order": null,
      "order_type": "direct_to_consumer",
      "email": null,
      "address_verified": null,
      "items_updateable": false,
      "address_message": null,
      "shop_warehouse_ids": [],
      "shop_shipping_method_currency": null,
      "shop_created_at": null,
      "shop_updated_at": null,
      "shop_shipping_method_text": "",
      "shop_shipping_method_price": "0.0",
      "billing_company": "",
      "billing_address_1": "",
      "billing_address_2": "",
      "billing_address_3": "",
      "billing_city": "",
      "billing_state": "",
      "billing_zip": "",
      "billing_country": "",
      "billing_phone": "",
      "billed": false,
      "billing_name": "",
      "first_name": null,
      "last_name": null,
      "full_name": null,
      "shipping_name": "William Tell",
      "shipping_company": "",
      "shipping_address_1": "",
      "shipping_address_2": "",
      "shipping_city": "",
      "shipping_state": "",
      "shipping_zip": "",
      "shipping_country": null,
      "shipping_country_iso2": "",
      "shipping_phone": "",
      "requested_address": "",
      "residential": true,
      "expedited": false,
      "require_signature": false,
      "require_adult_signature": false,
      "saturday_delivery": false,
      "gift": false,
      "insure": false,
      "contains_alcohol": false,
      "customs_required": true,
      "ship_actual_cost": null,
      "shipped_on": "2022-03-03T11:05:49.000-05:00",
      "ship_notes": null,
      "shipping_confirmation_sent": false,
      "ship_3rdparty_cost": "0.0",
      "ship_3rdparty_account": "",
      "ship_3rdparty_zip": "",
      "ship_3rdparty_country": "",
      "incoterm": null,
      "public_note": "",
      "days_in_transit": 1,
      "days_in_transit_carrier_estimate": null,
      "req_insurance_value": null,
      "ship_method": "Whiplash Cheapest Rate",
      "packingslip_pdf_url": null,
      "customs_vat_number": null,
      "customs_eori_number": null,
      "customs_ioss_number": null,
      "tracking": [],
      "tracking_links": [
        ""
      ],
      "approximate_delivery_date": null,
      "calculated_time_limit": 30,
      "within_return_time_limit": true,
      "return_name": null,
      "return_company": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_country": null,
      "return_zip": null,
      "return_phone": null,
      "return_email": null,
      "return_address_verified": null,
      "return_time_limit": null,
      "is_workable": true,
      "is_gestating": false,
      "permissions_limited": false,
      "order_items": [
        {
          "id": 5866169,
          "order_id": 2408144,
          "customer_id": 2779,
          "item_id": 2467445,
          "package_id": 2398139,
          "quote_item_id": null,
          "sku": "Horr-BOO-12",
          "description": "Dim candles in the night, 10 chilling ghost stories for non-believers",
          "quantity": 3,
          "price": "19.99",
          "created_at": "2022-03-01T16:34:40.000-05:00",
          "updated_at": "2022-03-01T16:37:09.000-05:00",
          "unshippable": false,
          "available": true,
          "packed": 3,
          "packaging": false,
          "wholesale_cost": null,
          "is_bundle": false,
          "retail_fee": null,
          "promo": false,
          "returnable": null,
          "currency": "USD",
          "wholesale_fee": null,
          "hazmat": true,
          "misc": null,
          "request_serial_number": false,
          "originator": {
            "id": 11296362,
            "originated_id": 5866169,
            "originated_type": "OrderItem",
            "shop_id": null,
            "provider": "whiplash",
            "original_id": null,
            "group_id": null,
            "misc": null,
            "active": true,
            "integration_id": null,
            "last_notified_at": null,
            "last_notification_status": null,
            "distinct_originator_key": null,
            "created_at": "2022-03-01T16:34:40.000-05:00",
            "updated_at": "2022-03-01T16:34:40.000-05:00",
            "application_id": null
          }
        },
        {
          "id": 5866170,
          "order_id": 2408144,
          "customer_id": 2779,
          "item_id": 2467446,
          "package_id": 2398139,
          "quote_item_id": null,
          "sku": "BOX-123-123",
          "description": "Test Box, It's a box for testing...",
          "quantity": 1,
          "price": "0.99",
          "created_at": "2022-03-01T16:36:40.000-05:00",
          "updated_at": "2022-03-01T16:36:41.000-05:00",
          "unshippable": false,
          "available": true,
          "packed": 1,
          "packaging": true,
          "wholesale_cost": null,
          "is_bundle": false,
          "retail_fee": null,
          "promo": false,
          "returnable": null,
          "currency": "USD",
          "wholesale_fee": null,
          "hazmat": true,
          "misc": null,
          "request_serial_number": false,
          "originator": {
            "id": 11296363,
            "originated_id": 5866170,
            "originated_type": "OrderItem",
            "shop_id": null,
            "provider": "whiplash",
            "original_id": null,
            "group_id": null,
            "misc": null,
            "active": true,
            "integration_id": null,
            "last_notified_at": null,
            "last_notification_status": null,
            "distinct_originator_key": null,
            "created_at": "2022-03-01T16:36:40.000-05:00",
            "updated_at": "2022-03-01T16:36:40.000-05:00",
            "application_id": null
          }
        }
      ],
      "originator": {
        "id": 11296361,
        "originated_id": 2408144,
        "originated_type": "Order",
        "shop_id": null,
        "provider": "whiplash",
        "original_id": null,
        "group_id": null,
        "misc": null,
        "active": true,
        "integration_id": null,
        "last_notified_at": null,
        "last_notification_status": null,
        "distinct_originator_key": null,
        "created_at": "2022-03-01T16:34:34.000-05:00",
        "updated_at": "2022-03-01T16:34:34.000-05:00",
        "application_id": null
      },
      "proto_originator_id": null,
      "packages": [
        {
          "id": 2398139,
          "order_id": 2408144,
          "shipped_on": null,
          "ship_actual_cost": null,
          "actual_weight": "64.0",
          "actual_width": "1.0",
          "actual_height": "1.0",
          "actual_length": "1.0",
          "actual_dimensional_weight": 0.006024096385542169,
          "tracking": null,
          "tracking_link": "",
          "order_item_ids": [
            5866169,
            5866170
          ],
          "created_at": "2022-03-01T16:34:34.000-05:00",
          "updated_at": "2022-03-03T11:05:49.000-05:00",
          "ucc128": null,
          "ship_actual_currency": null,
          "vics_bill_of_lading": "0023981392",
          "manifest_id": null
        }
      ],
      "shipping_method": {
        "id": 37,
        "carrier": "Whiplash",
        "service": "cheapest",
        "description": "Cheapest Rate",
        "name": "Whiplash Cheapest Rate",
        "international": false,
        "active": true,
        "flat_rate": false,
        "expedited": false,
        "trackable": true,
        "origins": [
          "US",
          "GB"
        ],
        "extended_description": null,
        "created_at": "2014-11-19T15:53:32.000-05:00",
        "updated_at": "2015-08-03T16:23:10.000-04:00"
      },
      "serial_numbers": []
    }
  },
  "fees": {
    "pick": "1.7",
    "pack": "2.95",
    "packaging": 0,
    "postage": 0,
    "total": "4.65",
    "currency": null
  },
  "event_name": "consumer_return.status_changed"
}
 


Payload of a return in Completed status:

{
  "consumer_return": {
    "id": 176380,
    "order_id": 2408144,
    "customer_id": 2779,
    "warehouse_id": 1,
    "sender": "William Tell",
    "eta": "2022-03-23T16:21:11.000-04:00",
    "status": 300,
    "status_name": "Completed",
    "received_by": "2932",
    "notes_by_whiplash": "",
    "notes_by_customer": null,
    "total_boxes": 1,
    "created_at": "2022-03-09T15:21:11.000-05:00",
    "updated_at": "2022-03-09T16:02:23.000-05:00",
    "arrived_at": "2022-03-09T15:45:04.000-05:00",
    "skip_images": null,
    "easypostable_id": null,
    "easypostable_type": "Shipment",
    "shipping_label_url": null,
    "ship_actual_cost": null,
    "shipping_method_text": null,
    "carrier": null,
    "tracking": null,
    "type": "ConsumerReturn",
    "postage_billed": null,
    "handling_billed": true,
    "ship_3rdparty_cost": null,
    "requires_label": true,
    "completed_at": "2022-03-09T16:02:23.000-05:00",
    "ship_actual_currency": null,
    "delivered_at": "2022-03-09T15:45:04.000-05:00",
    "due_at": "2022-03-14T16:00:00.000-04:00",
    "reference": null,
    "customer": {
      "id": 2779,
      "name": "Joey's Books",
      "created_at": "2022-02-25T16:17:45.000-05:00",
      "active": true,
      "auto_merge_gestation": null,
      "default_warehouse_id": 1,
      "eori_number": null,
      "estimated_monthly_volume": null,
      "fedex_account": null,
      "from_email": null,
      "instructions": null,
      "item_scanning_preference": true,
      "label_format": null,
      "notes": null,
      "notify_originator": true,
      "notify_originator_inventory": 2,
      "originator_permissions": false,
      "packing_slip_msg": null,
      "packingslip_template": null,
      "request_serial_numbers": false,
      "ship_method_preference": 0,
      "shipping_name": "Joey's Books",
      "ups_account": null,
      "vat_number": null,
      "ein": null,
      "warehouse_fallback": 0,
      "payment_hold": false,
      "whitelisted_warehouses": [
        {
          "id": 1,
          "name": "Ann Arbor",
          "timezone": "Eastern Time (US & Canada)",
          "timezone_raw": "America/New_York",
          "shipping_address_1": "4657 Platt Road",
          "shipping_address_2": "",
          "shipping_city": "Ann Arbor",
          "shipping_state": "Michigan",
          "shipping_zip": "48108",
          "shipping_country": "United States",
          "shipping_country_iso2": "US",
          "latitude": 42.2206,
          "longitude": -83.6989,
          "slug": "ann-arbor"
        }
      ],
      "allowed_warehouse_ids": [
        1
      ],
      "account_level": 200,
      "account_level_name": null,
      "activated_at": "2022-02-25T16:18:12.000-05:00",
      "deactivated_at": null,
      "auto_merge_skus": false,
      "billing_email": "Joe.Bookman@joeysbooks.com",
      "billing_contact_name": "Joe Bookman",
      "billing_company": null,
      "billing_phone1": "212-212-1212",
      "billing_phone2": null,
      "billing_address1": null,
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": null,
      "billing_state": null,
      "billing_zip": null,
      "billing_country": "US",
      "billing_residential": null,
      "items_returnable": true,
      "allow_international_returns": true,
      "items_exchangeable": true,
      "return_time_limit": 30,
      "return_label_expires_in": 29,
      "return_price_restricted": true,
      "return_sku_match": null,
      "rma_display_logo": true,
      "rma_footer_content": null,
      "return_name": null,
      "return_company": null,
      "return_email": null,
      "return_phone": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_zip": null,
      "return_country": null,
      "supports_return_labels": true,
      "logo_content_type": null,
      "logo_file_name": null,
      "logo_file_size": null,
      "logo_updated_at": null,
      "full_logo_url": "",
      "email_confirmation_from": "Joe.Bookman@joeysbooks.com",
      "email_confirmation_name": "Joe Bookman",
      "email_confirmation_msg": null,
      "email_confirmation_preference": 0,
      "email_confirmation_template": null,
      "low_inventory_threshold": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 1,
      "items_unavailable_on_sellout": 1,
      "replenishment_min": null,
      "replenishment_target": null,
      "location_default_return_role": "pickable",
      "location_enable_pending_returns": false
    },
    "warehouse": {
      "id": 1,
      "name": "Ann Arbor",
      "timezone": "Eastern Time (US & Canada)",
      "timezone_raw": "America/New_York",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": "",
      "shipping_city": "Ann Arbor",
      "shipping_state": "Michigan",
      "shipping_zip": "48108",
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "latitude": 42.2206,
      "longitude": -83.6989,
      "slug": "ann-arbor"
    },
    "originator": {
      "id": 11304402,
      "originated_id": 176380,
      "originated_type": "Shipnotice",
      "shop_id": null,
      "provider": "whiplash",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-09T15:21:11.000-05:00",
      "updated_at": "2022-03-09T15:21:11.000-05:00",
      "application_id": null
    },
    "return_items": [
      {
        "id": 402345,
        "item_id": 2467445,
        "name": "Dim candles in the night, 10 chilling ghost stories for non-believers",
        "sku": "Horr-BOO-12",
        "price": "19.99",
        "quantity": 3,
        "quantity_good": 3,
        "quantity_damaged": 0,
        "description": "Item not as expected: 3",
        "extended_description": "",
        "return_action": "refund: 3",
        "order_item_id": 5866169,
        "return_item_originator_id": null,
        "originator_id": null,
        "lot_ids": [
          null
        ]
      }
    ],
    "exchange_order": null,
    "order": {
      "id": 2408144,
      "customer_id": 2779,
      "order_batch_id": 119173,
      "quote_id": null,
      "warehouse_id": 1,
      "return_warehouse_id": 1,
      "shipping_method_id": 37,
      "estimated_shipping_method_id": null,
      "humanize_id": "2408144",
      "status": 450,
      "status_name": "Refund Requested",
      "previous_status": 300,
      "order_orig": "",
      "level1_token": "9fb99ee0be70676aa1eccac0a93a4387",
      "level2_token": "1fb53b7318a31a3dc5ed9c118f99f146",
      "workable_at": "2022-03-01T16:35:00.000-05:00",
      "skip_street_date": false,
      "due_at": "2022-03-02T16:00:00.000-05:00",
      "created_at": "2022-03-01T16:34:34.000-05:00",
      "updated_at": "2022-03-09T15:21:11.000-05:00",
      "meta_data": null,
      "customer_provided_label_carrier": null,
      "purchase_order": null,
      "order_type": "direct_to_consumer",
      "email": null,
      "address_verified": null,
      "items_updateable": false,
      "address_message": null,
      "shop_warehouse_ids": [],
      "shop_shipping_method_currency": null,
      "shop_created_at": null,
      "shop_updated_at": null,
      "shop_shipping_method_text": "",
      "shop_shipping_method_price": "0.0",
      "billing_company": "",
      "billing_address_1": "",
      "billing_address_2": "",
      "billing_address_3": "",
      "billing_city": "",
      "billing_state": "",
      "billing_zip": "",
      "billing_country": "",
      "billing_phone": "",
      "billed": false,
      "billing_name": "",
      "first_name": null,
      "last_name": null,
      "full_name": null,
      "shipping_name": "William Tell",
      "shipping_company": "",
      "shipping_address_1": "",
      "shipping_address_2": "",
      "shipping_city": "",
      "shipping_state": "",
      "shipping_zip": "",
      "shipping_country": null,
      "shipping_country_iso2": "",
      "shipping_phone": "",
      "requested_address": "",
      "residential": true,
      "expedited": false,
      "require_signature": false,
      "require_adult_signature": false,
      "saturday_delivery": false,
      "gift": false,
      "insure": false,
      "contains_alcohol": false,
      "customs_required": true,
      "ship_actual_cost": null,
      "shipped_on": "2022-03-03T11:05:49.000-05:00",
      "ship_notes": null,
      "shipping_confirmation_sent": false,
      "ship_3rdparty_cost": "0.0",
      "ship_3rdparty_account": "",
      "ship_3rdparty_zip": "",
      "ship_3rdparty_country": "",
      "incoterm": null,
      "public_note": "",
      "days_in_transit": 1,
      "days_in_transit_carrier_estimate": null,
      "req_insurance_value": null,
      "ship_method": "Whiplash Cheapest Rate",
      "packingslip_pdf_url": null,
      "customs_vat_number": null,
      "customs_eori_number": null,
      "customs_ioss_number": null,
      "tracking": [],
      "tracking_links": [
        ""
      ],
      "approximate_delivery_date": null,
      "calculated_time_limit": 30,
      "within_return_time_limit": true,
      "return_name": null,
      "return_company": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_country": null,
      "return_zip": null,
      "return_phone": null,
      "return_email": null,
      "return_address_verified": null,
      "return_time_limit": null,
      "is_workable": true,
      "is_gestating": false,
      "permissions_limited": false,
      "order_items": [
        {
          "id": 5866169,
          "order_id": 2408144,
          "customer_id": 2779,
          "item_id": 2467445,
          "package_id": 2398139,
          "quote_item_id": null,
          "sku": "Horr-BOO-12",
          "description": "Dim candles in the night, 10 chilling ghost stories for non-believers",
          "quantity": 3,
          "price": "19.99",
          "created_at": "2022-03-01T16:34:40.000-05:00",
          "updated_at": "2022-03-01T16:37:09.000-05:00",
          "unshippable": false,
          "available": true,
          "packed": 3,
          "packaging": false,
          "wholesale_cost": null,
          "is_bundle": false,
          "retail_fee": null,
          "promo": false,
          "returnable": null,
          "currency": "USD",
          "wholesale_fee": null,
          "hazmat": true,
          "misc": null,
          "request_serial_number": false,
          "originator": {
            "id": 11296362,
            "originated_id": 5866169,
            "originated_type": "OrderItem",
            "shop_id": null,
            "provider": "whiplash",
            "original_id": null,
            "group_id": null,
            "misc": null,
            "active": true,
            "integration_id": null,
            "last_notified_at": null,
            "last_notification_status": null,
            "distinct_originator_key": null,
            "created_at": "2022-03-01T16:34:40.000-05:00",
            "updated_at": "2022-03-01T16:34:40.000-05:00",
            "application_id": null
          }
        },
        {
          "id": 5866170,
          "order_id": 2408144,
          "customer_id": 2779,
          "item_id": 2467446,
          "package_id": 2398139,
          "quote_item_id": null,
          "sku": "BOX-123-123",
          "description": "Test Box, It's a box for testing...",
          "quantity": 1,
          "price": "0.99",
          "created_at": "2022-03-01T16:36:40.000-05:00",
          "updated_at": "2022-03-01T16:36:41.000-05:00",
          "unshippable": false,
          "available": true,
          "packed": 1,
          "packaging": true,
          "wholesale_cost": null,
          "is_bundle": false,
          "retail_fee": null,
          "promo": false,
          "returnable": null,
          "currency": "USD",
          "wholesale_fee": null,
          "hazmat": true,
          "misc": null,
          "request_serial_number": false,
          "originator": {
            "id": 11296363,
            "originated_id": 5866170,
            "originated_type": "OrderItem",
            "shop_id": null,
            "provider": "whiplash",
            "original_id": null,
            "group_id": null,
            "misc": null,
            "active": true,
            "integration_id": null,
            "last_notified_at": null,
            "last_notification_status": null,
            "distinct_originator_key": null,
            "created_at": "2022-03-01T16:36:40.000-05:00",
            "updated_at": "2022-03-01T16:36:40.000-05:00",
            "application_id": null
          }
        }
      ],
      "originator": {
        "id": 11296361,
        "originated_id": 2408144,
        "originated_type": "Order",
        "shop_id": null,
        "provider": "whiplash",
        "original_id": null,
        "group_id": null,
        "misc": null,
        "active": true,
        "integration_id": null,
        "last_notified_at": null,
        "last_notification_status": null,
        "distinct_originator_key": null,
        "created_at": "2022-03-01T16:34:34.000-05:00",
        "updated_at": "2022-03-01T16:34:34.000-05:00",
        "application_id": null
      },
      "proto_originator_id": null,
      "packages": [
        {
          "id": 2398139,
          "order_id": 2408144,
          "shipped_on": null,
          "ship_actual_cost": null,
          "actual_weight": "64.0",
          "actual_width": "1.0",
          "actual_height": "1.0",
          "actual_length": "1.0",
          "actual_dimensional_weight": 0.006024096385542169,
          "tracking": null,
          "tracking_link": "",
          "order_item_ids": [
            5866169,
            5866170
          ],
          "created_at": "2022-03-01T16:34:34.000-05:00",
          "updated_at": "2022-03-03T11:05:49.000-05:00",
          "ucc128": null,
          "ship_actual_currency": null,
          "vics_bill_of_lading": "0023981392",
          "manifest_id": null
        }
      ],
      "shipping_method": {
        "id": 37,
        "carrier": "Whiplash",
        "service": "cheapest",
        "description": "Cheapest Rate",
        "name": "Whiplash Cheapest Rate",
        "international": false,
        "active": true,
        "flat_rate": false,
        "expedited": false,
        "trackable": true,
        "origins": [
          "US",
          "GB"
        ],
        "extended_description": null,
        "created_at": "2014-11-19T15:53:32.000-05:00",
        "updated_at": "2015-08-03T16:23:10.000-04:00"
      },
      "serial_numbers": []
    }
  },
  "fees": {
    "pick": "1.7",
    "pack": "2.95",
    "packaging": 0,
    "postage": 0,
    "total": "4.65",
    "currency": null
  },
  "event_name": "consumer_return.status_changed"

 

Back to top of Events

Consumer Return Completed

{
  "consumer_return": {
    "id": 176380,
    "order_id": 2408144,
    "customer_id": 2779,
    "warehouse_id": 1,
    "sender": "William Tell",
    "eta": "2022-03-23T16:21:11.000-04:00",
    "status": 300,
    "status_name": "Completed",
    "received_by": "2932",
    "notes_by_whiplash": "",
    "notes_by_customer": null,
    "total_boxes": 1,
    "created_at": "2022-03-09T15:21:11.000-05:00",
    "updated_at": "2022-03-09T16:02:23.000-05:00",
    "arrived_at": "2022-03-09T15:45:04.000-05:00",
    "skip_images": null,
    "easypostable_id": null,
    "easypostable_type": "Shipment",
    "shipping_label_url": null,
    "ship_actual_cost": null,
    "shipping_method_text": null,
    "carrier": null,
    "tracking": null,
    "type": "ConsumerReturn",
    "postage_billed": null,
    "handling_billed": true,
    "ship_3rdparty_cost": null,
    "requires_label": true,
    "completed_at": "2022-03-09T16:02:23.000-05:00",
    "ship_actual_currency": null,
    "delivered_at": "2022-03-09T15:45:04.000-05:00",
    "due_at": "2022-03-14T16:00:00.000-04:00",
    "reference": null,
    "customer": {
      "id": 2779,
      "name": "Joey's Books",
      "created_at": "2022-02-25T16:17:45.000-05:00",
      "active": true,
      "auto_merge_gestation": null,
      "default_warehouse_id": 1,
      "eori_number": null,
      "estimated_monthly_volume": null,
      "fedex_account": null,
      "from_email": null,
      "instructions": null,
      "item_scanning_preference": true,
      "label_format": null,
      "notes": null,
      "notify_originator": true,
      "notify_originator_inventory": 2,
      "originator_permissions": false,
      "packing_slip_msg": null,
      "packingslip_template": null,
      "request_serial_numbers": false,
      "ship_method_preference": 0,
      "shipping_name": "Joey's Books",
      "ups_account": null,
      "vat_number": null,
      "ein": null,
      "warehouse_fallback": 0,
      "payment_hold": false,
      "whitelisted_warehouses": [
        {
          "id": 1,
          "name": "Ann Arbor",
          "timezone": "Eastern Time (US & Canada)",
          "timezone_raw": "America/New_York",
          "shipping_address_1": "4657 Platt Road",
          "shipping_address_2": "",
          "shipping_city": "Ann Arbor",
          "shipping_state": "Michigan",
          "shipping_zip": "48108",
          "shipping_country": "United States",
          "shipping_country_iso2": "US",
          "latitude": 42.2206,
          "longitude": -83.6989,
          "slug": "ann-arbor"
        }
      ],
      "allowed_warehouse_ids": [
        1
      ],
      "account_level": 200,
      "account_level_name": null,
      "activated_at": "2022-02-25T16:18:12.000-05:00",
      "deactivated_at": null,
      "auto_merge_skus": false,
      "billing_email": "Joe.Bookman@joeysbooks.com",
      "billing_contact_name": "Joe Bookman",
      "billing_company": null,
      "billing_phone1": "212-212-1212",
      "billing_phone2": null,
      "billing_address1": null,
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": null,
      "billing_state": null,
      "billing_zip": null,
      "billing_country": "US",
      "billing_residential": null,
      "items_returnable": true,
      "allow_international_returns": true,
      "items_exchangeable": true,
      "return_time_limit": 30,
      "return_label_expires_in": 29,
      "return_price_restricted": true,
      "return_sku_match": null,
      "rma_display_logo": true,
      "rma_footer_content": null,
      "return_name": null,
      "return_company": null,
      "return_email": null,
      "return_phone": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_zip": null,
      "return_country": null,
      "supports_return_labels": true,
      "logo_content_type": null,
      "logo_file_name": null,
      "logo_file_size": null,
      "logo_updated_at": null,
      "full_logo_url": "",
      "email_confirmation_from": "Joe.Bookman@joeysbooks.com",
      "email_confirmation_name": "Joe Bookman",
      "email_confirmation_msg": null,
      "email_confirmation_preference": 0,
      "email_confirmation_template": null,
      "low_inventory_threshold": null,
      "lot_control": false,
      "expiration_period": null,
      "ship_strategy": 1,
      "items_unavailable_on_sellout": 1,
      "replenishment_min": null,
      "replenishment_target": null,
      "location_default_return_role": "pickable",
      "location_enable_pending_returns": false
    },
    "warehouse": {
      "id": 1,
      "name": "Ann Arbor",
      "timezone": "Eastern Time (US & Canada)",
      "timezone_raw": "America/New_York",
      "shipping_address_1": "4657 Platt Road",
      "shipping_address_2": "",
      "shipping_city": "Ann Arbor",
      "shipping_state": "Michigan",
      "shipping_zip": "48108",
      "shipping_country": "United States",
      "shipping_country_iso2": "US",
      "latitude": 42.2206,
      "longitude": -83.6989,
      "slug": "ann-arbor"
    },
    "originator": {
      "id": 11304402,
      "originated_id": 176380,
      "originated_type": "Shipnotice",
      "shop_id": null,
      "provider": "whiplash",
      "original_id": null,
      "group_id": null,
      "misc": null,
      "active": true,
      "integration_id": null,
      "last_notified_at": null,
      "last_notification_status": null,
      "distinct_originator_key": null,
      "created_at": "2022-03-09T15:21:11.000-05:00",
      "updated_at": "2022-03-09T15:21:11.000-05:00",
      "application_id": null
    },
    "return_items": [
      {
        "id": 402345,
        "item_id": 2467445,
        "name": "Dim candles in the night, 10 chilling ghost stories for non-believers",
        "sku": "Horr-BOO-12",
        "price": "19.99",
        "quantity": 3,
        "quantity_good": 3,
        "quantity_damaged": 0,
        "description": "Item not as expected: 3",
        "extended_description": "",
        "return_action": "refund: 3",
        "order_item_id": 5866169,
        "return_item_originator_id": null,
        "originator_id": null,
        "lot_ids": [
          null
        ]
      }
    ],
    "exchange_order": null,
    "order": {
      "id": 2408144,
      "customer_id": 2779,
      "order_batch_id": 119173,
      "quote_id": null,
      "warehouse_id": 1,
      "return_warehouse_id": 1,
      "shipping_method_id": 37,
      "estimated_shipping_method_id": null,
      "humanize_id": "2408144",
      "status": 450,
      "status_name": "Refund Requested",
      "previous_status": 300,
      "order_orig": "",
      "level1_token": "9fb99ee0be70676aa1eccac0a93a4387",
      "level2_token": "1fb53b7318a31a3dc5ed9c118f99f146",
      "workable_at": "2022-03-01T16:35:00.000-05:00",
      "skip_street_date": false,
      "due_at": "2022-03-02T16:00:00.000-05:00",
      "created_at": "2022-03-01T16:34:34.000-05:00",
      "updated_at": "2022-03-09T15:21:11.000-05:00",
      "meta_data": null,
      "customer_provided_label_carrier": null,
      "purchase_order": null,
      "order_type": "direct_to_consumer",
      "email": null,
      "address_verified": null,
      "items_updateable": false,
      "address_message": null,
      "shop_warehouse_ids": [],
      "shop_shipping_method_currency": null,
      "shop_created_at": null,
      "shop_updated_at": null,
      "shop_shipping_method_text": "",
      "shop_shipping_method_price": "0.0",
      "billing_company": "",
      "billing_address_1": "",
      "billing_address_2": "",
      "billing_address_3": "",
      "billing_city": "",
      "billing_state": "",
      "billing_zip": "",
      "billing_country": "",
      "billing_phone": "",
      "billed": false,
      "billing_name": "",
      "first_name": null,
      "last_name": null,
      "full_name": null,
      "shipping_name": "William Tell",
      "shipping_company": "",
      "shipping_address_1": "",
      "shipping_address_2": "",
      "shipping_city": "",
      "shipping_state": "",
      "shipping_zip": "",
      "shipping_country": null,
      "shipping_country_iso2": "",
      "shipping_phone": "",
      "requested_address": "",
      "residential": true,
      "expedited": false,
      "require_signature": false,
      "require_adult_signature": false,
      "saturday_delivery": false,
      "gift": false,
      "insure": false,
      "contains_alcohol": false,
      "customs_required": true,
      "ship_actual_cost": null,
      "shipped_on": "2022-03-03T11:05:49.000-05:00",
      "ship_notes": null,
      "shipping_confirmation_sent": false,
      "ship_3rdparty_cost": "0.0",
      "ship_3rdparty_account": "",
      "ship_3rdparty_zip": "",
      "ship_3rdparty_country": "",
      "incoterm": null,
      "public_note": "",
      "days_in_transit": 1,
      "days_in_transit_carrier_estimate": null,
      "req_insurance_value": null,
      "ship_method": "Whiplash Cheapest Rate",
      "packingslip_pdf_url": null,
      "customs_vat_number": null,
      "customs_eori_number": null,
      "customs_ioss_number": null,
      "tracking": [],
      "tracking_links": [
        ""
      ],
      "approximate_delivery_date": null,
      "calculated_time_limit": 30,
      "within_return_time_limit": true,
      "return_name": null,
      "return_company": null,
      "return_address_1": null,
      "return_address_2": null,
      "return_city": null,
      "return_state": null,
      "return_country": null,
      "return_zip": null,
      "return_phone": null,
      "return_email": null,
      "return_address_verified": null,
      "return_time_limit": null,
      "is_workable": true,
      "is_gestating": false,
      "permissions_limited": false,
      "order_items": [
        {
          "id": 5866169,
          "order_id": 2408144,
          "customer_id": 2779,
          "item_id": 2467445,
          "package_id": 2398139,
          "quote_item_id": null,
          "sku": "Horr-BOO-12",
          "description": "Dim candles in the night, 10 chilling ghost stories for non-believers",
          "quantity": 3,
          "price": "19.99",
          "created_at": "2022-03-01T16:34:40.000-05:00",
          "updated_at": "2022-03-01T16:37:09.000-05:00",
          "unshippable": false,
          "available": true,
          "packed": 3,
          "packaging": false,
          "wholesale_cost": null,
          "is_bundle": false,
          "retail_fee": null,
          "promo": false,
          "returnable": null,
          "currency": "USD",
          "wholesale_fee": null,
          "hazmat": true,
          "misc": null,
          "request_serial_number": false,
          "originator": {
            "id": 11296362,
            "originated_id": 5866169,
            "originated_type": "OrderItem",
            "shop_id": null,
            "provider": "whiplash",
            "original_id": null,
            "group_id": null,
            "misc": null,
            "active": true,
            "integration_id": null,
            "last_notified_at": null,
            "last_notification_status": null,
            "distinct_originator_key": null,
            "created_at": "2022-03-01T16:34:40.000-05:00",
            "updated_at": "2022-03-01T16:34:40.000-05:00",
            "application_id": null
          }
        },
        {
          "id": 5866170,
          "order_id": 2408144,
          "customer_id": 2779,
          "item_id": 2467446,
          "package_id": 2398139,
          "quote_item_id": null,
          "sku": "BOX-123-123",
          "description": "Test Box, It's a box for testing...",
          "quantity": 1,
          "price": "0.99",
          "created_at": "2022-03-01T16:36:40.000-05:00",
          "updated_at": "2022-03-01T16:36:41.000-05:00",
          "unshippable": false,
          "available": true,
          "packed": 1,
          "packaging": true,
          "wholesale_cost": null,
          "is_bundle": false,
          "retail_fee": null,
          "promo": false,
          "returnable": null,
          "currency": "USD",
          "wholesale_fee": null,
          "hazmat": true,
          "misc": null,
          "request_serial_number": false,
          "originator": {
            "id": 11296363,
            "originated_id": 5866170,
            "originated_type": "OrderItem",
            "shop_id": null,
            "provider": "whiplash",
            "original_id": null,
            "group_id": null,
            "misc": null,
            "active": true,
            "integration_id": null,
            "last_notified_at": null,
            "last_notification_status": null,
            "distinct_originator_key": null,
            "created_at": "2022-03-01T16:36:40.000-05:00",
            "updated_at": "2022-03-01T16:36:40.000-05:00",
            "application_id": null
          }
        }
      ],
      "originator": {
        "id": 11296361,
        "originated_id": 2408144,
        "originated_type": "Order",
        "shop_id": null,
        "provider": "whiplash",
        "original_id": null,
        "group_id": null,
        "misc": null,
        "active": true,
        "integration_id": null,
        "last_notified_at": null,
        "last_notification_status": null,
        "distinct_originator_key": null,
        "created_at": "2022-03-01T16:34:34.000-05:00",
        "updated_at": "2022-03-01T16:34:34.000-05:00",
        "application_id": null
      },
      "proto_originator_id": null,
      "packages": [
        {
          "id": 2398139,
          "order_id": 2408144,
          "shipped_on": null,
          "ship_actual_cost": null,
          "actual_weight": "64.0",
          "actual_width": "1.0",
          "actual_height": "1.0",
          "actual_length": "1.0",
          "actual_dimensional_weight": 0.006024096385542169,
          "tracking": null,
          "tracking_link": "",
          "order_item_ids": [
            5866169,
            5866170
          ],
          "created_at": "2022-03-01T16:34:34.000-05:00",
          "updated_at": "2022-03-03T11:05:49.000-05:00",
          "ucc128": null,
          "ship_actual_currency": null,
          "vics_bill_of_lading": "0023981392",
          "manifest_id": null
        }
      ],
      "shipping_method": {
        "id": 37,
        "carrier": "Whiplash",
        "service": "cheapest",
        "description": "Cheapest Rate",
        "name": "Whiplash Cheapest Rate",
        "international": false,
        "active": true,
        "flat_rate": false,
        "expedited": false,
        "trackable": true,
        "origins": [
          "US",
          "GB"
        ],
        "extended_description": null,
        "created_at": "2014-11-19T15:53:32.000-05:00",
        "updated_at": "2015-08-03T16:23:10.000-04:00"
      },
      "serial_numbers": []
    }
  },
  "fees": {
    "pick": "1.7",
    "pack": "2.95",
    "packaging": 0,
    "postage": 0,
    "total": "4.65",
    "currency": null
  },
  "event_name": "consumer_return.completed"

Back to top of Events