Orders API

This is Documentation for the V1 API

V2 API docmentation is located at developers.getwhiplash.com/

Orders

Get a list of Orders

Get a list of all orders for a customer account.

GET https://www.whiplashmerch.com/api/ordersView Response

HTTP/1.1 200 OK
[
  {
    "id":123456,
    "billed":true,
    "created_at":"2017-05-18T07:59:32-04:00",
    "days_in_transit":1,
    "days_in_transit_carrier_estimate":null,
    "email":"email@example.com",
    "gift":false,
    "originator_notified":false,
    "shop_shipping_method_price":"8.91",
    "shop_shipping_method_text":"Priority Mail",
    "shop_shipping_method_currency":"USD",
    "shop_warehouse_ids":[],
    "shop_created_at":"2017-05-18T07:59:31-04:00",
    "shop_updated_at":"2017-05-18T07:59:32-04:00",
    "ship_3rdparty_cost":"0.0",
    "ship_actual_cost":"77.7",
    "ship_method":"USPS Priority Mail",
    "ship_notes":null,
    "shipped_on":"2013-06-06T15:55:30-04:00",
    "shipping_address_1":"1800 Hemlock St.",
    "shipping_address_2":null,
    "shipping_city":"Beverley Hills",
    "shipping_company":null,
    "shipping_country":"United States",
    "shipping_country_iso2":"US",
    "shipping_name":"Bill Murray",
    "shipping_phone":"",
    "shipping_state":"CA",
    "shipping_zip":"90210",
    "status":300,
    "shipping_confirmation_sent":false,
    "updated_at":"2017-05-18T07:59:33-04:00",
    "tracking":["1ZE190000000000000"],
    "tracking_links":["http://www.usps/com/tracking/1ZE190000000000000"],
    "approximate_delivery_date": "2013-06-07",
    "originator_id":"5623643082",
    "originator_group_id":null,
    "proto_originator_id":"5623643082",
    "provider":"api",
    "insure":false,
    "require_signature":false,
    "saturday_delivery":false,
    "insurance_value":"48.0",
    "level1_token":"13PKVSFLIW69r97782",
    "level2_token":"2DHFIP56Y2PKa97782",
    "public_note":null,
    "warehouse_id":5,
    "return_warehouse_id":5,
    "address_verified":true,
    "address_message":null,
    "require_adult_signature":false,
    "contains_alcohol":false,
    "monetary_value":"48.0",
    "status_name":"Shipped",
    "customer_id":1234,
    "skip_address_verification":false,
    "currency":"USD",
    "batched":false,
    "reference":null,
    "req_ship_method_price":"0.0",
    "req_ship_method_text":null,
    "return_address_1":null,
    "return_address_2":null,
    "return_approved_token":"CEFG5436VG678",
    "return_city":null,
    "return_company":null,
    "return_name":null,
    "return_country":null,
    "return_email":null,
    "return_phone":null,
    "return_state":null,
    "return_zip":null,
    "ship_3rdparty_zip":null,
    "ship_3rdparty_country":null,
    "ship_3rdparty_account":null,
    "incoterm":null,
    "order_items":[
      {
        "id":1111,
        "item_id":2345,
        "order_id":1234,
        "package_id":4321,
        "packaging":false,
        "packed":0,
        "price":"88.0",
        "retail_fee":null,
        "wholesale_cost":null,
        "currency":"USD",
        "quantity":1,
        "sku":"TEST1234",
        "description":"Gray Dress Pant Yoga Pants (Straight-Leg) - X-Small Petite",
        "available":true,
        "returnable":null,
        "originator_id":"order_1234-item_1234",
        "provider":"api",
        "created_at":"2017-05-07T18:10:56-04:00",
        "updated_at":"2017-05-07T18:10:56-04:00",
        "serialnumbers":[]
      }
    ]
  }
]

Parameters

Name	Type	Description
`limit`	Integer	The number of orders returned. Default is 50
`status`	Integer/Array	Show orders matching the specified status(es). You may specify multiple statuses.
`offset/page`	Integer	Page to show (defaults to 1)
`order_by`	String	Order (defaults to updated_at DESC
`since_id`	Integer	Restrict results to after the specified ID
`provider`	String	Show orders matching the specified provider
`originator_group`	String	Show orders matching the specified originator group
`reference`	String	Reference name or number--this is usually the originator_id--but may include an exchange/replace/split suffix
`created_at_min`	Datetime	Show orders created after date (format: 2008-01-01 03:00)
`created_at_max`	Datetime	Show orders created before date (format: 2008-01-01 03:00)
`updated_at_min`	Datetime	Show orders last updated after date (format: 2008-01-01 03:00)
`updated_at_max`	Datetime	Show orders last updated before date (format: 2008-01-01 03:00)
`shipping_country`	String/Array	Show orders matching a given shipping country code. You may specify multiple country codes.
`shipping_country_not`	String/Array	Show orders NOT matching a given shipping country code. You may specify multiple country codes.
`item_availability`	String	Select orders by item availability.

Order Count

Get the total number of orders for a customer account.

GET https://www.whiplashmerch.com/api/orders/countView Response

HTTP/1.1 200 OK
123333

Parameters

Name	Type	Description
`status`	Integer/Array	Show orders matching the specified status(es). You may specify multiple statuses.
`since_id`	Integer	Restrict results to after the specified ID
`provider`	String	Show orders matching the specified provider
`originator_group`	String	Show orders matching the specified originator group
`reference`	String	Reference name or number--this is usually the originator_id--but may include an exchange/replace/split suffix
`created_at_min`	Datetime	Show orders created after date (format: 2008-01-01 03:00)
`created_at_max`	Datetime	Show orders created before date (format: 2008-01-01 03:00)
`updated_at_min`	Datetime	Show orders last updated after date (format: 2008-01-01 03:00)
`updated_at_max`	Datetime	Show orders last updated before date (format: 2008-01-01 03:00)
`shipping_country`	String/Array	Show orders matching a given shipping country code. You may specify multiple country codes.
`shipping_country_not`	String/Array	Show orders NOT matching a given shipping country code. You may specify multiple country codes.
`item_availability`	String	Select orders by item availability.

Get a single Order

Get an order using its Whiplash ID

GET https://www.whiplashmerch.com/api/orders/{order-id}View Response

HTTP/1.1 200 OK
{
  "id":123456,
  "billed":true,
  "created_at":"2017-05-18T07:59:32-04:00",
  "days_in_transit":1,
  "days_in_transit_carrier_estimate":null,
  "email":"email@example.com",
  "gift":false,
  "originator_notified":false,
  "shop_shipping_method_price":"8.91",
  "shop_shipping_method_text":"Priority Mail",
  "shop_shipping_method_currency":"USD",
  "shop_warehouse_ids":[],
  "shop_created_at":"2017-05-18T07:59:31-04:00",
  "shop_updated_at":"2017-05-18T07:59:32-04:00",
  "ship_3rdparty_cost":"0.0",
  "ship_actual_cost":"77.7",
  "ship_method":"USPS Priority Mail",
  "ship_notes":null,
  "shipped_on":"2013-06-06T15:55:30-04:00",
  "shipping_address_1":"1800 Hemlock St.",
  "shipping_address_2":null,
  "shipping_city":"Beverley Hills",
  "shipping_company":null,
  "shipping_country":"United States",
  "shipping_country_iso2":"US",
  "shipping_name":"Bill Murray",
  "shipping_phone":"",
  "shipping_state":"CA",
  "shipping_zip":"90210",
  "status":300,
  "shipping_confirmation_sent":false,
  "updated_at":"2017-05-18T07:59:33-04:00",
  "tracking":["1ZE190000000000000"],
  "tracking_links":["http://www.usps/com/tracking/1ZE190000000000000"],
  "approximate_delivery_date": "2013-06-07",
  "originator_id":"5623643082",
  "originator_group_id":null,
  "proto_originator_id":"5623643082",
  "provider":"api",
  "insure":false,
  "require_signature":false,
  "saturday_delivery":false,
  "insurance_value":"48.0",
  "level1_token":"13PKVSFLIW69r97782",
  "level2_token":"2DHFIP56Y2PKa97782",
  "public_note":null,
  "warehouse_id":5,
  "return_warehouse_id":5,
  "address_verified":true,
  "address_message":null,
  "require_adult_signature":false,
  "contains_alcohol":false,
  "monetary_value":"48.0",
  "status_name":"Shipped",
  "customer_id":1234,
  "skip_address_verification":false,
  "currency":"USD",
  "batched":false,
  "reference":null,
  "req_ship_method_price":"0.0",
  "req_ship_method_text":null,
  "return_address_1":null,
  "return_address_2":null,
  "return_approved_token":"CEFG5436VG678",
  "return_city":null,
  "return_company":null,
  "return_name":null,
  "return_country":null,
  "return_email":null,
  "return_phone":null,
  "return_state":null,
  "return_zip":null,
  "ship_3rdparty_zip":null,
  "ship_3rdparty_country":null,
  "ship_3rdparty_account":null,
  "incoterm":null,
  "order_items":[
    {
      "id":1111,
      "item_id":2345,
      "order_id":1234,
      "package_id":4321,
      "packaging":false,
      "packed":0,
      "price":"88.0",
      "retail_fee":null,
      "wholesale_cost":null,
      "currency":"USD",
      "quantity":1,
      "sku":"TEST1234",
      "description":"Gray Dress Pant Yoga Pants (Straight-Leg) - X-Small Petite",
      "available":true,
      "returnable":null,
      "originator_id":"order_1234-item_1234",
      "provider":"api",
      "created_at":"2017-05-07T18:10:56-04:00",
      "updated_at":"2017-05-07T18:10:56-04:00",
      "serialnumbers":[]
    }
  ]
}

Get a single Order using a custom Originator ID

Orders received via an e-commerce platform or our API also store the incoming ID as the originator_id. You can find and update using this ID as well.

GET https://www.whiplashmerch.com/api/orders/originator/{originator-id}View Response

HTTP/1.1 200 OK
{
  "id":123456,
  "billed":true,
  "created_at":"2017-05-18T07:59:32-04:00",
  "days_in_transit":1,
  "days_in_transit_carrier_estimate":null,
  "email":"email@example.com",
  "gift":false,
  "originator_notified":false,
  "shop_shipping_method_price":"8.91",
  "shop_shipping_method_text":"Priority Mail",
  "shop_shipping_method_currency":"USD",
  "shop_warehouse_ids":[],
  "shop_created_at":"2017-05-18T07:59:31-04:00",
  "shop_updated_at":"2017-05-18T07:59:32-04:00",
  "ship_3rdparty_cost":"0.0",
  "ship_actual_cost":"77.7",
  "ship_method":"USPS Priority Mail",
  "ship_notes":null,
  "shipped_on":"2013-06-06T15:55:30-04:00",
  "shipping_address_1":"1800 Hemlock St.",
  "shipping_address_2":null,
  "shipping_city":"Beverley Hills",
  "shipping_company":null,
  "shipping_country":"United States",
  "shipping_country_iso2":"US",
  "shipping_name":"Bill Murray",
  "shipping_phone":"",
  "shipping_state":"CA",
  "shipping_zip":"90210",
  "status":300,
  "shipping_confirmation_sent":false,
  "updated_at":"2017-05-18T07:59:33-04:00",
  "tracking":["1ZE190000000000000"],
  "tracking_links":["http://www.usps/com/tracking/1ZE190000000000000"],
  "approximate_delivery_date": "2013-06-07",
  "originator_id":"5623643082",
  "originator_group_id":null,
  "proto_originator_id":"5623643082",
  "provider":"api",
  "insure":false,
  "require_signature":false,
  "saturday_delivery":false,
  "insurance_value":"48.0",
  "level1_token":"13PKVSFLIW69r97782",
  "level2_token":"2DHFIP56Y2PKa97782",
  "public_note":null,
  "warehouse_id":5,
  "return_warehouse_id":5,
  "address_verified":true,
  "address_message":null,
  "require_adult_signature":false,
  "contains_alcohol":false,
  "monetary_value":"48.0",
  "status_name":"Shipped",
  "customer_id":1234,
  "skip_address_verification":false,
  "currency":"USD",
  "batched":false,
  "reference":null,
  "req_ship_method_price":"0.0",
  "req_ship_method_text":null,
  "return_address_1":null,
  "return_address_2":null,
  "return_approved_token":"CEFG5436VG678",
  "return_city":null,
  "return_company":null,
  "return_name":null,
  "return_country":null,
  "return_email":null,
  "return_phone":null,
  "return_state":null,
  "return_zip":null,
  "ship_3rdparty_zip":null,
  "ship_3rdparty_country":null,
  "ship_3rdparty_account":null,
  "incoterm":null,
  "order_items":[
    {
      "id":1111,
      "item_id":2345,
      "order_id":1234,
      "package_id":4321,
      "packaging":false,
      "packed":0,
      "price":"88.0",
      "retail_fee":null,
      "wholesale_cost":null,
      "currency":"USD",
      "quantity":1,
      "sku":"TEST1234",
      "description":"Gray Dress Pant Yoga Pants (Straight-Leg) - X-Small Petite",
      "available":true,
      "returnable":null,
      "originator_id":"order_1234-item_1234",
      "provider":"api",
      "created_at":"2017-05-07T18:10:56-04:00",
      "updated_at":"2017-05-07T18:10:56-04:00",
      "serialnumbers":[]
    }
  ]
}

Create an Order

POST https://www.whiplashmerch.com/api/ordersView Response

HTTP/1.1 200 OK
{
  "id":123456,
  "billed":true,
  "created_at":"2017-05-18T07:59:32-04:00",
  "days_in_transit":1,
  "days_in_transit_carrier_estimate":null,
  "email":"email@example.com",
  "gift":false,
  "originator_notified":false,
  "shop_shipping_method_price":"8.91",
  "shop_shipping_method_text":"Priority Mail",
  "shop_shipping_method_currency":"USD",
  "shop_warehouse_ids":[],
  "shop_created_at":"2017-05-18T07:59:31-04:00",
  "shop_updated_at":"2017-05-18T07:59:32-04:00",
  "ship_3rdparty_cost":"0.0",
  "ship_actual_cost":"77.7",
  "ship_method":"USPS Priority Mail",
  "ship_notes":null,
  "shipped_on":"2013-06-06T15:55:30-04:00",
  "shipping_address_1":"1800 Hemlock St.",
  "shipping_address_2":null,
  "shipping_city":"Beverley Hills",
  "shipping_company":null,
  "shipping_country":"United States",
  "shipping_country_iso2":"US",
  "shipping_name":"Bill Murray",
  "shipping_phone":"",
  "shipping_state":"CA",
  "shipping_zip":"90210",
  "status":300,
  "shipping_confirmation_sent":false,
  "updated_at":"2017-05-18T07:59:33-04:00",
  "tracking":["1ZE190000000000000"],
  "tracking_links":["http://www.usps/com/tracking/1ZE190000000000000"],
  "approximate_delivery_date": "2013-06-07",
  "originator_id":"5623643082",
  "originator_group_id":null,
  "proto_originator_id":"5623643082",
  "provider":"api",
  "insure":false,
  "require_signature":false,
  "saturday_delivery":false,
  "insurance_value":"48.0",
  "level1_token":"13PKVSFLIW69r97782",
  "level2_token":"2DHFIP56Y2PKa97782",
  "public_note":null,
  "warehouse_id":5,
  "return_warehouse_id":5,
  "address_verified":true,
  "address_message":null,
  "require_adult_signature":false,
  "contains_alcohol":false,
  "monetary_value":"48.0",
  "status_name":"Shipped",
  "customer_id":1234,
  "skip_address_verification":false,
  "currency":"USD",
  "batched":false,
  "reference":null,
  "req_ship_method_price":"0.0",
  "req_ship_method_text":null,
  "return_address_1":null,
  "return_address_2":null,
  "return_approved_token":"CEFG5436VG678",
  "return_city":null,
  "return_company":null,
  "return_name":null,
  "return_country":null,
  "return_email":null,
  "return_phone":null,
  "return_state":null,
  "return_zip":null,
  "ship_3rdparty_zip":null,
  "ship_3rdparty_country":null,
  "ship_3rdparty_account":null,
  "incoterm":null,
  "order_items":[
    {
      "id":1111,
      "item_id":2345,
      "order_id":1234,
      "package_id":4321,
      "packaging":false,
      "packed":0,
      "price":"88.0",
      "retail_fee":null,
      "wholesale_cost":null,
      "currency":"USD",
      "quantity":1,
      "sku":"TEST1234",
      "description":"Gray Dress Pant Yoga Pants (Straight-Leg) - X-Small Petite",
      "available":true,
      "returnable":null,
      "originator_id":"order_1234-item_1234",
      "provider":"api",
      "created_at":"2017-05-07T18:10:56-04:00",
      "updated_at":"2017-05-07T18:10:56-04:00",
      "serialnumbers":[]
    }
  ]
}

Parameters

Name	Type	Description
`shipping_name`	String	Shipping recipient's name (required)
`shipping_company`	String	Shipping company name (optional)
`shipping_address_1`	String	Street Address 1 (required)
`shipping_address_2`	String	Street Address 2 (optional)
`shipping_city`	String	Shipping city (required)
`shipping_state`	String	State or Province (if applicable)
`shipping_country`	String	Shipping country (2 digit ISO format)
`shipping_zip`	String	Shipping postal code (required)
`email`	String	Shipping recipient's e-mail address (required)
`return_address_1`	String	Return Street Address 1 (optional)
`return_address_2`	String	Return Street Address 2 (optional)
`return_city`	String	Return city (optional)
`return_company`	String	Return company (optional)
`return_name`	String	Return name (optional)
`return_country`	String	Return country (optional)
`return_phone`	String	Return phone (optional)
`return_email`	String	Return email (optional)
`return_state`	String	Return state (optional)
`return_zip`	String	Return postal code (optional)
`return_company`	String	Return company (optional)
`public_note`	String	A note to be displayed on the order's packing slip (optional)
`shipping_phone`	String	Shipping phone number (optional)
`ship_notes`	String	Additional shipping instructions (optional)
`shop_shipping_method_text`	String	Desired shipping method (optional)
`shop_shipping_method_price`	String	What the end consumer paid for shipping (optional)
`shop_shipping_method_currency`	String	The currency the shipping was paid in (optional)
`shop_created_at`	Datetime	When this order was placed in the originating shop (optional)
`shop_updated_at`	Datetime	When this order was last updated in the originating shop (optional)
`shop_warehouse_id`	Integer	Which warehouse should this ship from (optional)
`days_in_transit`	Integer	Number of days to release an order prior to its Street Date (optional)
`originator_id`	String	The order's ID in your system (you can use this to find the order - optional)
`proto_originator_id`	String	The order's ID in your system for a separated or replacement order (you can use this to find the order - optional)
`insure`	Boolean	Do you want to purchase insurance for this order? (optional - default is false)
`insurance_value`	Decimal	Amount to insure this order for (optional)
`require_signature`	Boolean	Do you want to require a signature on receipt for this order? (optional - default is false)
`saturday_delivery`	Boolean	Do you require a Saturday delivery window? (optional - default is false)
`gift`	String	Is this order a gift (for customs declaration - default is false)
`address_verified`	Boolean	Is the shipping address verified? (optional)
`address_message`	String	Message giving additional information about the shipping address (optional)
`require_adult_signature`	Boolean	Do you want to require an adult signature on receipt for this order? (optional - default is false)
`contains_alcohol`	Boolean	Does the order contain alcohol? (optional - default is false)
`ship_3rdparty_zip`	String	The account zip code for third party billing for postage (optional)
`ship_3rdparty_country`	String	The account country for third party billing for postage (optional)
`ship_3rdparty_account`	String	The account number for third party billing for postage (optional)
`incoterm`	String	EXW - Ex Works; FCA - Free Carrier; CPT - Carriage Paid To; CIP - Carriage and Insurance Paid to; DAT - Delivered At Terminal; DAP - Delivered At Place; DDP - Delivered Duty Paid; FAS - Free Alongside Ship; FOB - Free on Board; CFR - Cost and Freight; CIF - Cost
`order_items`	Array	The items in this order (see Order Items API for formatting)

Update an Order

Note: Orders may only be updated before they have been shipped (status < 300).

Note: Once an order is created, you should edit and add order items individually.

PUT https://www.whiplashmerch.com/api/orders/{order-id}View Response

HTTP/1.1 204 No Content

Parameters

Name	Type	Description
`shipping_name`	String	Shipping recipient's name (required)
`shipping_company`	String	Shipping company name (optional)
`shipping_address_1`	String	Street Address 1 (required)
`shipping_address_2`	String	Street Address 2 (optional)
`shipping_city`	String	Shipping city (required)
`shipping_state`	String	State or Province (if applicable)
`shipping_country`	String	Shipping country (2 digit ISO format)
`shipping_zip`	String	Shipping postal code (required)
`email`	String	Shipping recipient's e-mail address (required)
`return_address_1`	String	Return Street Address 1 (optional)
`return_address_2`	String	Return Street Address 2 (optional)
`return_city`	String	Return city (optional)
`return_company`	String	Return company (optional)
`return_name`	String	Return name (optional)
`return_country`	String	Return country (optional)
`return_phone`	String	Return phone (optional)
`return_email`	String	Return email (optional)
`return_state`	String	Return state (optional)
`return_zip`	String	Return postal code (optional)
`return_company`	String	Return company (optional)
`public_note`	String	A note to be displayed on the order's packing slip (optional)
`shipping_phone`	String	Shipping phone number (optional)
`ship_notes`	String	Additional shipping instructions (optional)
`shop_shipping_method_text`	String	Desired shipping method (optional)
`shop_shipping_method_price`	String	What the end consumer paid for shipping (optional)
`shop_shipping_method_currency`	String	The currency the shipping was paid in (optional)
`shop_created_at`	Datetime	When this order was placed in the originating shop (optional)
`shop_updated_at`	Datetime	When this order was last updated in the originating shop (optional)
`shop_warehouse_id`	Integer	Which warehouse should this ship from (optional)
`days_in_transit`	Integer	Number of days to release an order prior to its Street Date (optional)
`days_in_transit_carrier_estimate`	Integer	Estimated number of days from shipping to delivery (optional)
`originator_id`	String	The order's ID in your system (you can use this to find the order - optional)
`proto_originator_id`	String	The order's ID in your system for a separated or replacement order (you can use this to find the order - optional)
`insure`	Boolean	Do you want to purchase insurance for this order? (optional - default is false)
`insurance_value`	Decimal	Amount to insure this order for (optional)
`require_signature`	Boolean	Do you want to require a signature on receipt for this order? (optional - default is false)
`saturday_delivery`	Boolean	Do you require a Saturday delivery window? (optional - default is false)
`gift`	String	Is this order a gift (for customs declaration - default is false)
`address_verified`	Boolean	Is the shipping address verified? (optional)
`address_message`	String	Message giving additional information about the shipping address (optional)
`require_adult_signature`	Boolean	Do you want to require an adult signature on receipt for this order? (optional - default is false)
`contains_alcohol`	Boolean	Does the order contain alcohol? (optional - default is false)
`ship_3rdparty_zip`	String	The account zip code for third party billing for postage (optional)
`ship_3rdparty_country`	String	The account country for third party billing for postage (optional)
`ship_3rdparty_account`	String	The account number for third party billing for postage (optional)
`incoterm`	String	EXW - Ex Works; FCA - Free Carrier; CPT - Carriage Paid To; CIP - Carriage and Insurance Paid to; DAT - Delivered At Terminal; DAP - Delivered At Place; DDP - Delivered Duty Paid; FAS - Free Alongside Ship; FOB - Free on Board; CFR - Cost and Freight; CIF - Cost
`order_items`	Array	The items in this order (see Order Items API for formatting)

Cancel an Order

Note: Orders may only be cancelled before they have been shipped (status < 300).

PUT https://www.whiplashmerch.com/api/orders/{order-id}/cancelView Response

HTTP/1.1 204 No Content

Un-Cancel an Order

Note: Orders may only be un-cancelled if they are cancelled (status = 40).

PUT https://www.whiplashmerch.com/api/orders/{order-id}/uncancelView Response

HTTP/1.1 204 No Content

Pause an Order

Note: Orders may only be paused before they have been shipped (status < 300).

PUT https://www.whiplashmerch.com/api/orders/{order-id}/pauseView Response

HTTP/1.1 204 No Content

Release (Unpause) an Order

Unpause a currently paused order.

PUT https://www.whiplashmerch.com/api/orders/{order-id}/releaseView Response

HTTP/1.1 204 No Content

Anonymize an Order

Anonymize an order's end consumer data, per GDPR guidelines.

PUT https://www.whiplashmerch.com/api/orders/{order-id}/anonymizeView Response

HTTP/1.1 204 No Content

Get an Order's Packages

A Shipped order will have one ore more packages.

NOTE: Orders that haven't shipped yet (status < 300) will return a 403 response and an error message.

GET https://www.whiplashmerch.com/api/orders/{order-id}/packagesView Response

HTTP/1.1 200 OK
[
  {
    "id":98765,
    "order_id":123456,
    "batch_id":null,
    "manifest_id":null,
    "actual_weight":null,
    "actual_width":null,
    "actual_length":null,
    "actual_height":null,
    "actual_dimensional_weight":null,
    "bill_of_lading":null,
    "created_at":"2017-05-18T06:26:30-04:00",
    "updated_at":"2017-05-18T07:01:13-04:00"
    "pack_fee_actual":null,
    "packaging_fee_actual":null,
    "pick_fee_actual":null,
    "scan_form_url":null,
    "ship_actual_cost":"38.85",
    "ship_actual_currency":"USD",
    "shipment_created_at":"2017-05-18T06:54:11-04:00",
    "shipment_id":"shp_fe327dca62f548ffb53a9199cfa4e8ae",
    "shipment_updated_at":"2017-05-18T06:54:11-04:00",
    "shipped_on":"2017-05-18T07:01:14-04:00",
    "tracking":"EZ100000012345",
    "shipping_label_content_type":null,
    "shipping_label_file_name":null,
    "shipping_label_file_size":null,
    "shipping_label_updated_at":null,
    "shipping_label_url":"https://easypost-files.s3-us-west-2.amazonaws.com/files/postage_label/20170518/12345678.epl2",
  }
]

Get an Order's Fees

A Shipped order will have fees incurred.

NOTE: Orders that haven't shipped yet (status < 300) will return a 403 response and an error message.

GET https://www.whiplashmerch.com/api/orders/{order-id}/feesView Response

HTTP/1.1 200 OK
{
  "pick":19.58,
  "pack":3.0,
  "packaging":3.2,
  "postage":77.7,
  "total":103.48
}

Order Statuses

All orders will have one of the following statuses:

Code	Name
`30`	Shipped Externally
`35`	Quote
`40`	Cancelled
`45`	Closed by Originator
`50`	Unpaid
`75`	Pending Return
`77`	Return Verified
`80`	Pre-Order
`90`	Paused
`95`	Insufficient Inventory
`100`	Processing
`120`	Printed
`150`	Picked
`155`	Prepacking in Progress
`160`	Packed
`200`	Label Scheduled for Purchase
`250`	Label Purchased
`300`	Shipped
`325`	Picked Up
`350`	Delivered
`375`	Return Expired
`380`	Replacement Cancelled
`400`	Returned Undeliverable
`410`	Replacement Requested
`430`	Exchanged
`450`	Refund Requested

Shipping Methods

All orders will have one of the following Shipping Methods:

APC Priority International

APC parcelConnectPriorityDDPDelcon

Asendia Overnight

Asendia Priority Tracked

Asendia ePacket Elite

Asendia ePacket Plus

Asendia ePacket Select

AustraliaPost ExpressPost

AustraliaPost ExpressPostSignature

AustraliaPost ParcelPost

AustraliaPost ParcelPostExtra

AustraliaPost ParcelPostSignature

AustraliaPost ParcelPostWinePlusSignature

Axlehire axlehire_next_day

Axlehire axlehire_same_day

CanadaPost Expedited Parcel

CanadaPost Expedited Parcel USA

CanadaPost International Parcel Service

CanadaPost Priority

CanadaPost Priority Worldwide Envelope International

CanadaPost Priority Worldwide Envelope USA

CanadaPost Priority Worldwide Pak International

CanadaPost Priority Worldwide Pak USA

CanadaPost Priority Worldwide Parcel USA

CanadaPost Small Packet International Air

CanadaPost Small Packet USA Air

CanadaPost Tracked Packet International

CanadaPost Tracked Packet USA

CanadaPost Xpresspost

CanadaPost Xpresspost International

CanadaPost Xpresspost USA

CanadaPost regularparcel

DHL Domestic Express

DHL EXPRESS 10:30

DHL EXPRESS 12:00

DHL EXPRESS 9:00

DHL EXPRESS WORLDWIDE NON DOC

DHL Express Economy Select

DHL Express Worldwide

DHL Domestic Express 1200

DHL Express Easy Non Doc (Intl)

DHL Express Worldwide Ecx

DHL Express1200 Non Doc

DHLGlobalMail Smartmail Parcel

DHLGlobalMailInternational(Legacy) International Standard DDU

DHLeCommerce SM Marketing Parcel Expedited

DPDUK Air Classic International Air

DPDUK Air Express International Air

DPDUK ExpressPackClassic

DPDUK Parcel Dpd Classic Int

DPDUK Parcel Dpd Next Day

DPDUK Parcel Dpd Next Day Int

DPDUK Parcel Dpd Two Day

DPDUK Parcel Dpd Two Day Int

DPDUK Parcel Saturday 12

DPDUK ParcelDpdClassicDT1

Dhl ecommerce DHLParcelPlusGround

Dhl ecommerce International Direct

Dhl ecommerce International Standard

Dhl ecommerce globalmail packet priority

DhlEcs DHLParcelExpedited

DhlEcs DHLParcelExpeditedMax

DhlEcs DHLParcelGround

DhlEcs International Direct v4

DhlEcs International Standard v4

FedEx 2 Day

FedEx 2 Day (Intl)

FedEx Express Saver

FedEx Express Saver (Intl)

FedEx Ground

FedEx Ground (Intl)

FedEx Ground Home Delivery

FedEx International Economy

FedEx International Priority

FedEx ONE_RATE_2_DAY

FedEx Priority Overnight

FedEx Priority Overnight (Intl)

FedEx SameDay City Economy

FedEx Standard Overnight

FedEx Standard Overnight (Intl)

FedExSmartPost SmartPost

GSO CaliforniaParcelService

GSO EarlyPriorityOvernight

GSO EarlySaturdayService

GSO Ground

GSO PriorityOvernight

GSO SaturdayDeliveryService

Globale

Globale Global-E Express

Globegistics E Com Tracked Ddp

Maergo Standard Expedited

OmniParcel E Commerce Express Tracked

OmniParcel E Commerce Standard Tracked

PassportGlobal Economy

PassportGlobal Priority Duties Paid

PassportGlobal Priority Tracked

RoyalMail 24

RoyalMail 48

RoyalMail International Business Mail Large Letter Zone Sort Priority

RoyalMail International Business Parcels Bespoke Postal (DW1)

RoyalMail International Business Parcels Tracked

RoyalMail International Business Parcels Tracked Country

UPS Standard

UPS Standard (Intl)

UPS Economy Mail Innovations

UPS Expedited Mail Innovations

UPS Ground

UPS Next Day Air

UPS Next Day Air Early A.M.

UPS Next Day Air Saver

UPS Priority Mail Innovations

UPS Second Day Air

UPS Second Day Air A.M.

UPS Three-Day Select

UPS Worldwide Expedited

UPS Worldwide Expedited (intl)

UPS Worldwide Express

UPS Worldwide Express Plus

UPS Worldwide Saver

UPS Worldwide Saver (intl)

UPSSurePost Over 1 lb

UPSSurePost Under 1 lb

UPSi-Parcel UPSIparcel

USPS Express Mail

USPS Express Mail International

USPS First Class Mail

USPS First Class Mail International

USPS First Class Package International

USPS Media Mail

USPS Parcel Select

USPS Priority Mail

USPS Priority Mail International

USPSScanBasedReturns USPS Return Label First Class

USPSScanBasedReturns USPS Return Label Priority

Whiplash Cheapest 1 Day or Better

Whiplash Cheapest 1 Day or Better (International)

Whiplash Cheapest 2 Days or Better

Whiplash Cheapest 2 Days or Better (International)

Whiplash Cheapest 3 Days or Better

Whiplash Cheapest 3 Days or Better (International)

Whiplash Cheapest 5 Days or Better

Whiplash Cheapest 5 Days or Better (International)

Whiplash Cheapest 7 Days or Better

Whiplash Cheapest 7 Days or Better (International)

Whiplash Cheapest Expedited

Whiplash Cheapest Expedited (International)

Whiplash Cheapest Rate

Whiplash Cheapest Rate (International)

Whiplash Cheapest Tracked

Whiplash Cheapest Tracked (International)

Whiplash Customer Provided Label

Whiplash Customer Provided Label (intl)

Whiplash Pick Up

Whiplash Pick Up (Intl)

X delivery Standard Expedited

Item Availability

Orders can be selected based upon the following item availability:

Code	Name
`all`	all items are available
`any`	at least one item is available
`mixed`	at least one item is available, and at least one is not available
`none`	no items are available

Provider

You can select orders based on the provider (i.e. commerce platform like Shopify, Magento, etc).

Sometimes, when an order is replaced or is split into multiple orders, the provider is set to whiplash:XXXX. You may filter by these as well. We use many of these internally, but the following may be helpful:

NOTE: Orders with a whiplash provider will typically have an originator_id pointing to a whiplash order.

Provider	Description
`whiplash:replace`	The order was replaced-- either because the original failed to arrive at its destination, or because there was a problem with the order. The original order retains its original `originator_id`.
`whiplash:exchange`	The order was an exchange. The original order retains its original `originator_id`.
`whiplash:separate`	An order was created by splitting an item from an existing order. The original order retains its original `originator_id`.
`whiplash`	This will grab the above two providers, as well any order that was created manually in whiplash.

Originator Group

While you will typically look up orders via their Whiplash id or their originator_id, occasionally one order will be split into several orders, will be exchanged, or will be replaced. In this case, all of the new orders will have been originated by the first, and their originator_group_id will be the original order's Whiplash id.

Split will not have an originator_id. And their provider will be whiplash:separate

Additionally, replacement and separated orders will have a distinct proto_originator_id field. This is the replacement or separated order's original order id in your system.