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,
    "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,
    "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_country":null,
    "return_email":null,
    "return_phone":null,
    "return_state":null,
    "return_zip":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

NameTypeDescription
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

NameTypeDescription
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,
  "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,
  "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_country":null,
  "return_email":null,
  "return_phone":null,
  "return_state":null,
  "return_zip":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,
  "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,
  "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_country":null,
  "return_email":null,
  "return_phone":null,
  "return_state":null,
  "return_zip":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,
  "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,
  "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_country":null,
  "return_email":null,
  "return_phone":null,
  "return_state":null,
  "return_zip":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

NameTypeDescription
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_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)
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

NameTypeDescription
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_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)
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

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,
    "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:

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

Shipping Methods

All orders will have one of the following Shipping Methods:

Asendia International Business Parcels Zero Sort Economy
Asendia Priority Tracked
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 Small Packet International Air
CanadaPost Tracked Packet International
CanadaPost Tracked Packet USA
CanadaPost Xpresspost
CanadaPost Xpresspost International
CanadaPost Xpresspost USA
DHL EXPRESS 10:30
DHL EXPRESS 12:00
DHL EXPRESS 9:00
DHL EXPRESS WORLDWIDE
DPDUK Air Classic International Air
DPDUK Air Express International Air
DPDUK Parcel Dpd Classic
DPDUK Parcel Dpd Classic
DPDUK Parcel Dpd Next Day
DPDUK Parcel Dpd Next Day
DPDUK Parcel Dpd Two Day
DPDUK Parcel Dpd Two Day
FedEx 2 Day
FedEx 2 Day, Early AM
FedEx Express Saver
FedEx First Overnight
FedEx Ground
FedEx Ground Home Delivery
FedEx International Economy
FedEx International First
FedEx International Priority
FedEx Priority Overnight
FedEx Standard Overnight
FedExSmartPost SmartPost
ParcelForce Euro Priority Business
ParcelForce Express 10
ParcelForce Express 24
ParcelForce Express 48
ParcelForce Express 9
ParcelForce Express AM
ParcelForce Global Priority
ParcelForce Global Value
RoyalMail 24
RoyalMail 48
RoyalMail International Business Mail Large Letter Zone Sort Priority
RoyalMail International Business Parcels Tracked
RoyalMail International Business Parcels Tracked And Signed
RoyalMail International Business Parcels Zero Sort Economy
RoyalMail International Business Parcels Zero Sort Low Volume Priority
RoyalMail International Business Parcels Zero Sort Priority
RoyalMail International Business Parcels Zone Sort Priority
RoyalMail International Tracked
RoyalMail International Tracked And Signed
RoyalMail Tracked 48 Signature
UPS Economy 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 Express
UPS Worldwide Express Plus
UPS Worldwide Saver
UPSSurePost Over 1 lb
UPSSurePost Under 1 lb
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 Rate
Whiplash Cheapest Rate
Whiplash Customer Provided Label
Whiplash Customer Provided Label
Whiplash Pick Up
Whiplash Pickup
Whiplash Royal Mail Signed For
Whiplash Royal Mail Signed For: Non-UK
Whiplash Royal Mail Standard
Whiplash Royal Mail Standard: Non-UK

Item Availability

Orders can be selected based upon the following item availability:

CodeName
allall items are available
anyat least one item is available
mixedat least one item is available, and at least one is not available
noneno 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.

ProviderDescription
whiplash:replaceThe order was replaced--either as an Exchange, 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:separateAn order was created by splitting an item from an existing order. The original order retains its original originator_id.
whiplashThis 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.