Download OpenAPI specification:Download
The Whiplash V2 API is open by invite only. Fill out request form here.
V2 documentation
V2.1 documentation
Items are probably the most fundamental entity in the Whiplash system. An item is simply a 'shippable unit'. So, it's not a Whiplash T-Shirt; it's a Small Whiplash T-Shirt, for instance.
Most commerce platforms model Products. Typically, however, a Product (e.g. a T-Shirt) has variations (named variously, Variants, ProductOptions, OptionSets, etc). An Item maps to the Variant/Option, not the Product.
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
sku | string the item SKU number |
title | string the item title |
description | string the item description |
full_description | string the full item description |
customer_id | integer <int32> the id of the customer the item belongs to |
weight | number <float> the weight of the item (in pounds) |
available | boolean is the item available? |
image_originator_url | string the originator url for the item image |
vendor | string the item vendor |
scancode | string the item scancode |
price | number <float> the item price |
media_mail | boolean is the item eligible for media mail? |
packaging | boolean is the item packaging? |
length | number <float> the item length (in inches) |
width | number <float> the item width (in inches) |
height | number <float> the item height (in inches) |
active | boolean is the item active? |
wholesale_cost | number <float> the wholesale cost of the item |
is_bundle | boolean is the item a bundle? |
packaging_type | string Enum: "WhiplashBag" "WhiplashBox" "WhiplashBubbleMailer" "WhiplashFill" "WhiplashFlat" "WhiplashTube" "WhiplashNoPackaging" "WhiplashPallet" "Card" "Letter" "Flat" "Parcel" "LargeParcel" "IrregularParcel" "FlatRateEnvelope" "FlatRateLegalEnvelope" "FlatRatePaddedEnvelope" "FlatRateGiftCardEnvelope" "FlatRateWindowEnvelope" "FlatRateCardboardEnvelope" "SmallFlatRateEnvelope" "SmallFlatRateBox" "MediumFlatRateBox" "LargeFlatRateBox" "RegionalRateBoxA" "RegionalRateBoxB" "RegionalRateBoxC" "LargeFlatRateBoardGameBox" "UPSLetter" "UPSExpressBox" "UPS25kgBox" "UPS10kgBox" "Tube" "Pak" "Pallet" "SmallExpressBox" "MediumExpressBox" "LargeExpressBox" "FedExEnvelope" "FedExBox" "FedExPak" "FedExTube" "FedEx10kgBox" "FedEx25kgBox" "BPM" "LargeLetter" "SmallParcel" "MediumParcel" the item packaging type |
promo | boolean is the item a promo? |
street_date | string <date-time> the item street date |
category | string the item category |
include_inbound_in_published | boolean include inbound items in published? |
returnable | boolean is the item returnable? |
return_sku_match | string the item return SKU match |
return_price_restricted | boolean is the item return price restricted? |
request_serial_number | boolean does the item require a serial number when shipping? |
currency | string the item currency |
tariff_number | string the item harmonized tariff number (for international shipping) |
notify_originator_inventory | integer <int32> notify originator inventory? |
name | string the item name and description, formatted nicely |
hazmat | boolean (deprecated) is the item hazmat? |
hazmat_type | string Enum: "ormd" "lithium" "ORMD" "LITHIUM" hazmat class |
misc | string miscellaneous information about the item |
ean | string the EAN number for the item |
lot_control | boolean does this item require lot control? |
expiration_period | integer <int32> items that are this many days from expiration will not be allowed to ship |
ship_strategy | integer <int32> which locations to pick first: Default, FIFO, FEFO |
velocity | integer <int32> Average number of units expected to sell in a day |
case_quantity | integer <int32> How many of this item to a case? |
carton_quantity | integer <int32> How many CASES to a carton? |
origin_country | string Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "PS" "OM" "PK" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" The country of origin for this item (as an iso2 country code) |
alcohol | boolean Does this order contain alcohol? |
shippable_container | boolean Is this item a shippable container? |
replenishment_min | number <float> Minimum number of days worth of stock to keep in forward pick locations |
replenishment_target | number <float> Target number of days stock to replenish forward pick locations |
low_inventory_threshold | integer <int32> the item quantity where this item would be considered having low inventory |
Array of objects | |
object Hash of key value pairs (must conform to available meta keys) |
{- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "customer_id": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "originators_attributes": [
- {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}
], - "meta_fields": {
- "fields": { }
}
}
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
]
Update Item meta fields
id required | integer <int32> |
fields | object Hash of key/value pairs |
association_fields | object Included meta fields for associations |
{- "fields": { },
- "association_fields": { }
}
{- "message": "string"
}
An item may have many alternate scancodes
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "item_id": 0,
- "primary": true,
- "customer_id": 0,
- "name": "string",
- "scancode": "string",
- "active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "label_format": "string"
}
]
Retrieve the quantity of this item in each warehouse in which it has stock
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string",
- "quantity": 0,
- "projected_quantity": 0,
- "sellable_quantity": 0
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "parent_item_id": 0,
- "item_id": 0,
- "bundle_id": 0,
- "quantity": 0,
- "max_per_package": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
A Bundle is an Item representing a set of Items to be grouped and shipped together.
Creating Product Bundles is useful when you sell a set of items, but you also sell the items individually. Creating a bundle allows us to keep the inventory flexible so we can ship the constituent items as they are sold individually, or as a set.
In most cases, it's simplest to use Whiplash bundles as a replacement for your e-commerce platform's bundle feature / plugin.
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
quantity required | integer <int32> the bundle item quantity |
item_id required | integer <int32> the bundle item item id |
{- "quantity": 0,
- "item_id": 0
}
{- "id": 0,
- "parent_item_id": 0,
- "item_id": 0,
- "bundle_id": 0,
- "quantity": 0,
- "max_per_package": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "message": "string"
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
sku | string the item SKU number |
title | string the item title |
description | string the item description |
full_description | string the full item description |
customer_id | integer <int32> the id of the customer the item belongs to |
quantity | integer <int32> the available quantity of the item |
weight | number <float> the weight of the item (in pounds) |
available | boolean is the item available? |
image_originator_url | string the originator url for the item image |
vendor | string the item vendor |
scancode | string the item scancode |
price | number <float> the item price |
media_mail | boolean is the item eligible for media mail? |
packaging | boolean is the item packaging? |
length | number <float> the item length (in inches) |
width | number <float> the item width (in inches) |
height | number <float> the item height (in inches) |
active | boolean is the item active? |
wholesale_cost | number <float> the wholesale cost of the item |
is_bundle | boolean is the item a bundle? |
packaging_type | string Enum: "WhiplashBag" "WhiplashBox" "WhiplashBubbleMailer" "WhiplashFill" "WhiplashFlat" "WhiplashTube" "WhiplashNoPackaging" "WhiplashPallet" "Card" "Letter" "Flat" "Parcel" "LargeParcel" "IrregularParcel" "FlatRateEnvelope" "FlatRateLegalEnvelope" "FlatRatePaddedEnvelope" "FlatRateGiftCardEnvelope" "FlatRateWindowEnvelope" "FlatRateCardboardEnvelope" "SmallFlatRateEnvelope" "SmallFlatRateBox" "MediumFlatRateBox" "LargeFlatRateBox" "RegionalRateBoxA" "RegionalRateBoxB" "RegionalRateBoxC" "LargeFlatRateBoardGameBox" "UPSLetter" "UPSExpressBox" "UPS25kgBox" "UPS10kgBox" "Tube" "Pak" "Pallet" "SmallExpressBox" "MediumExpressBox" "LargeExpressBox" "FedExEnvelope" "FedExBox" "FedExPak" "FedExTube" "FedEx10kgBox" "FedEx25kgBox" "BPM" "LargeLetter" "SmallParcel" "MediumParcel" the item packaging type |
promo | boolean is the item a promo? |
street_date | string <date-time> the item street date |
category | string the item category |
include_inbound_in_published | boolean include inbound items in published? |
returnable | boolean is the item returnable? |
return_sku_match | string the item return SKU match |
return_price_restricted | boolean is the item return price restricted? |
request_serial_number | boolean does the item require a serial number when shipping? |
currency | string the item currency |
tariff_number | string the item harmonized tariff number (for international shipping) |
notify_originator_inventory | integer <int32> notify originator inventory? |
name | string the item name and description, formatted nicely |
hazmat | boolean (deprecated) is the item hazmat? |
hazmat_type | string Enum: "ormd" "lithium" "ORMD" "LITHIUM" hazmat class |
misc | string miscellaneous information about the item |
ean | string the EAN number for the item |
lot_control | boolean does this item require lot control? |
expiration_period | integer <int32> items that are this many days from expiration will not be allowed to ship |
ship_strategy | integer <int32> which locations to pick first: Default, FIFO, FEFO |
velocity | integer <int32> Average number of units expected to sell in a day |
case_quantity | integer <int32> How many of this item to a case? |
carton_quantity | integer <int32> How many CASES to a carton? |
origin_country | string Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "PS" "OM" "PK" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" The country of origin for this item (as an iso2 country code) |
alcohol | boolean Does this order contain alcohol? |
shippable_container | boolean Is this item a shippable container? |
replenishment_min | number <float> Minimum number of days worth of stock to keep in forward pick locations |
replenishment_target | number <float> Target number of days stock to replenish forward pick locations |
low_inventory_threshold | integer <int32> the item quantity where this item would be considered having low inventory |
published_quantity | integer <int32> item quantity, inluding inbound items |
{- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
{- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
Actions can be performed UPON an item. They don't necessarily update the item itself. You can see which actions are available to you at /items/actions
action required | string |
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
args | object Method params |
{- "args": { }
}
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
{- "count": 0
}
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
[- {
- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
]
Get all transactions for an item
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
[- {
- "id": 0,
- "item_id": 0,
- "order_id": 0,
- "shipnotice_id": 0,
- "user_id": 0,
- "rule_id": 0,
- "description": "string",
- "quantity": 0,
- "change": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
This removes the item from the bundle, but does not affect the item in any other way.
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
{- "message": "string"
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
quantity | integer <int32> the bundle item quantity |
{- "quantity": 0
}
{- "id": 0,
- "parent_item_id": 0,
- "item_id": 0,
- "bundle_id": 0,
- "quantity": 0,
- "max_per_package": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
{- "id": 0,
- "parent_item_id": 0,
- "item_id": 0,
- "bundle_id": 0,
- "quantity": 0,
- "max_per_package": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Orders are end consumer requests for Items. An Order is comprised of OrderItems.
Orders represent outgoing stock.
Create an order
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
shipping_method_id | integer <int32> the order shipping method id |
estimated_shipping_method_id | integer <int32> the estimated order shipping method id, if set to cheapest rate |
humanize_id | string the order humanized id |
order_orig | string the order original id (from the shop that sent whiplash the order) |
level1_token | string the order level 1 token |
level2_token | string the order level 2 token |
skip_street_date | boolean skip street date for this order? |
due_at | string <date-time> the order due at date and time |
meta_data | string meta data for this order as stringified JSON |
customer_provided_label_carrier | string the carrier on the customer provided label (for tracking purposes) |
purchase_order | string the purchase order this order |
order_type | string Enum: "direct_to_consumer" "dropship" "retail" "transfer" "wholesale" the order type |
string the order shipping email | |
items_updateable | boolean are the items in the order updateable |
skip_address_verification | boolean skip order shipping address verification? (staff only) |
shop_warehouse_ids | Array of integers <int32> [ items <int32 > ] the order shop warehouse ids |
shop_shipping_method_currency | string the order shop shipping method currency |
shop_created_at | string <date-time> the order shop creation date and time |
shop_updated_at | string <date-time> the order shop last update date and time |
shop_shipping_method_text | string the order shop shipping method text |
shop_shipping_method_price | number <float> the order shop shipping method price |
billing_company | string the order billing company |
billing_address_1 | string the order billing street address 1 |
billing_address_2 | string the order billing street address 2 |
billing_address_3 | string the order billing street address 3 |
billing_city | string the order billing city |
billing_state | string the order billing state |
billing_zip | string the order billing zip |
billing_country | string the order billing country |
billing_phone | string the order billing phone number |
do_not_bill | boolean do not bill for the order? (staff only) |
billing_name | string the order billing name |
first_name | string the first name of the person the order is being shipped to |
last_name | string the last name of the person the order is being shipped to |
full_name | string the full name of the person the order is being shipped to |
shipping_name | string the order shipping name |
shipping_company | string the order shipping company |
shipping_address_1 | string the order shipping street address 1 |
shipping_address_2 | string the order shipping street address 2 |
shipping_city | string the order shipping city |
shipping_state | string the order shipping state |
shipping_zip | string the order shipping zip |
shipping_country | string the order shipping country |
shipping_country_iso2 | string the order shipping country iso2 (US, GB, CA, etc) |
shipping_phone | string the order shipping phone number |
requested_address | string the order requested address |
residential | boolean is the order address residential? |
expedited | boolean is the order expedited? |
require_signature | boolean does the order require a signature upon delivery? |
require_adult_signature | boolean does the order require an adult signature upon delivery? |
saturday_delivery | boolean require a carrier that delivers on Saturdays for this order? |
gift | boolean is the order a gift? |
insure | boolean is the order insured? |
contains_alcohol | boolean does the order contain alcohol? |
customs_required | boolean does the order require customs documents? |
shipping_carrier_facility | string carrier facility access point for the address destination |
shipping_hold_for_pickup | boolean pickup option for carrier facility on the address destination |
ship_notes | string the order ship notes |
ship_3rdparty_cost | number <float> the order third party shipping cost |
ship_3rdparty_account | string the order third party shipping account |
ship_3rdparty_zip | string the order third party shipping zip |
ship_3rdparty_country | string the order third party shipping country |
public_note | string the order public note |
days_in_transit | integer <int32> the order estimated days in transit (used for release planning) |
days_in_transit_carrier_estimate | integer <int32> the order estimated days in transit estimate from the carrier |
req_insurance_value | number <float> the order requested insurance value |
cf_packingslip_pdf_url | string packingslip pdf url |
customs_vat_number | string Value Added Tax identifcation number for the sender of the order |
customs_eori_number | string Economic Operators Registration and Identification number for the sender of the order |
customs_ioss_number | string Import One-Stop Shop number for the sender of the order |
carrier_account_id | integer <int32> the carrier account id for this package, if it has shipped (staff only) |
tracking | Array of strings the order tracking numbers |
tracking_links | Array of strings the order tracking links |
approximate_delivery_date | string <date> the order approxiamte delivery date |
global_e_ge_order | boolean is the order a global_e order? |
calculated_time_limit | string the orders calculated return time limit |
within_return_time_limit | boolean is the order within its return time limit |
return_name | string the order return name |
return_company | string the order return company |
return_address_1 | string the order return street address 1 |
return_address_2 | string the order return street address 2 |
return_city | string the order return city |
return_state | string the order return state |
return_country | string the order return country |
return_zip | string the order return zip |
return_phone | string the order return phone number |
return_email | string the order return email |
return_time_limit | integer <int32> the order return time limit |
is_workable | boolean is the order workable? |
is_gestating | boolean is the order gestating? |
permissions_limited | boolean Permission limited orders are not editable, but still may be processed/shipped |
incoterm | string Enum: "EXW" "FCA" "CPT" "CIP" "DAT" "DAP" "DDP" "FAS" "FOB" "CFR" "CIF" "DAF" "DES" "DEQ" "DDU" desired incoterm for the order |
status | integer <int32> Enum: 30 35 the order status |
Array of objects | |
object | |
object Hash of key value pairs (must conform to available meta keys) | |
string |
{- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "direct_to_consumer",
- "email": "string",
- "items_updateable": true,
- "skip_address_verification": true,
- "shop_warehouse_ids": [
- 0
], - "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_notes": "string",
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": [
- "string"
], - "tracking_links": [
- "string"
], - "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "incoterm": "EXW",
- "status": 30,
- "order_items_attributes": [
- {
- "quantity": 0,
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "sku": "string",
- "description": "string",
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator_id": "string",
- "item_originator_id": "string",
- "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}
}
], - "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}, - "meta_fields": {
- "fields": { },
- "association_fields": { }
}, - "": "string"
}
{- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
Retrieves a list of orders
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 2649730,
- "customer_id": 3500,
- "order_batch_id": 1247,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": 37,
- "estimated_shipping_method_id": null,
- "humanize_id": "2649730-L7A82982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "L7A82982",
- "level1_token": "9768d33d593a19717a68b9dfbf9675c8",
- "level2_token": "fb413dd4aafab627a0bcc9779e17dc63",
- "workable_at": "2019-08-29T11:15:34-04:00",
- "skip_street_date": false,
- "due_at": "2019-08-30T16:00:00-04:00",
- "created_at": "2019-08-29T11:15:33-04:00",
- "updated_at": "2019-08-29T11:17:40-04:00",
- "meta_data": null,
- "is_quote": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Tora Boyer",
- "shipping_company": null,
- "shipping_address_1": "3513 Kris Motorway",
- "shipping_address_2": null,
- "shipping_city": "Port Terrell",
- "shipping_state": "Mississippi",
- "shipping_zip": "83067",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "shipping_phone": null,
- "email": "chang@kuphal.biz",
- "requested_address": "3513 Kris Motorway\nPort Terrell, Mississippi 83067\nUnited States",
- "residential": true,
- "address_verified": true,
- "address_message": ": . : ",
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "customer_provided_label_carrier": null,
- "shipping_vendor": null,
- "shipping_distribution_center": null,
- "shipping_department": null,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": "Whiplash Cheapest Rate",
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6326347,
- "order_id": 2649730,
- "customer_id": 3500,
- "item_id": 1242663,
- "package_id": 2306625,
- "quote_item_id": null,
- "sku": "JO-0008",
- "description": "Jagged Oxford, Size 8",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2019-08-29T11:15:33-04:00",
- "updated_at": "2019-08-29T11:15:33-04: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": false,
- "misc": null,
- "originator": {
- "id": 10213638,
- "originated_id": 6326347,
- "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": "2019-08-29T11:15:33-04:00",
- "updated_at": "2019-08-29T11:15:33-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10213637,
- "originated_id": 2649730,
- "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": "2019-08-29T11:15:33-04:00",
- "updated_at": "2019-08-29T11:15:33-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306625,
- "order_id": 2649730,
- "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": "",
- "bill_of_lading": null,
- "created_at": "2019-08-29T11:15:33-04:00",
- "updated_at": "2019-08-29T11:15:33-04:00",
- "ucc128": null,
- "order_item_ids": [
- 6326347
]
}
], - "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-05:00",
- "updated_at": "2015-08-03T16:23:10-04:00"
}, - "serial_numbers": [ ]
}, - {
- "id": 2649766,
- "customer_id": 3515,
- "order_batch_id": 2034,
- "quote_id": null,
- "warehouse_id": 11,
- "return_warehouse_id": 11,
- "shipping_method_id": 37,
- "estimated_shipping_method_id": null,
- "humanize_id": "2649766-SCA22730",
- "status": 160,
- "status_name": "Packed",
- "previous_status": 160,
- "order_orig": "SCA22730",
- "level1_token": "47709f25a7b8cf8391a55e831fc1d5b9",
- "level2_token": "46fa6e825aaa51f603811b06106b2789",
- "workable_at": "2019-09-10T13:48:37.000-04:00",
- "skip_street_date": false,
- "due_at": "2019-09-11T16:00:00.000-04:00",
- "created_at": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:37.000-04:00",
- "meta_data": null,
- "is_quote": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Gerardo Ullrich",
- "shipping_company": null,
- "shipping_address_1": "15897 Harvey Shoal",
- "shipping_address_2": null,
- "shipping_city": "Port Craigchester",
- "shipping_state": "Wisconsin",
- "shipping_zip": "10527-5506",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "shipping_phone": null,
- "email": "herlindabashirian@aufderhar.co",
- "requested_address": "15897 Harvey Shoal\nPort Craigchester, Wisconsin 10527-5506\nUnited States",
- "residential": true,
- "address_verified": true,
- "address_message": "address: Address not found",
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "customer_provided_label_carrier": null,
- "shipping_vendor": null,
- "shipping_distribution_center": null,
- "shipping_department": null,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": "Whiplash Cheapest Rate",
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6326398,
- "order_id": 2649766,
- "customer_id": 3515,
- "item_id": 1243235,
- "package_id": 2306660,
- "quote_item_id": null,
- "sku": "SSJIW-0002",
- "description": "Simple Salvage Jeans In White, Size 2",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04: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": false,
- "misc": null,
- "originator": {
- "id": 10214555,
- "originated_id": 6326398,
- "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": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04:00",
- "application_id": null
}
}, - {
- "id": 6326402,
- "order_id": 2649766,
- "customer_id": 3515,
- "item_id": 828641,
- "package_id": 2306660,
- "quote_item_id": null,
- "sku": "S-12661",
- "description": "32X22 KRAFT JUMBO EZFOLD MLR",
- "quantity": 1,
- "price": "5.64",
- "created_at": "2019-09-10T12:48:37.000-04:00",
- "updated_at": "2019-09-10T12:48:37.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10214584,
- "originated_id": 6326402,
- "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": "2019-09-10T12:48:37.000-04:00",
- "updated_at": "2019-09-10T12:48:37.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10214554,
- "originated_id": 2649766,
- "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": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306660,
- "order_id": 2649766,
- "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": "",
- "bill_of_lading": null,
- "created_at": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04:00",
- "ucc128": null,
- "order_item_ids": [
- 6326398,
- 6326402
]
}
], - "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": [ ]
}, - {
- "id": 2649742,
- "customer_id": 3506,
- "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": "2649742-DCA47956",
- "status": 80,
- "status_name": "Pre-Order",
- "previous_status": 100,
- "order_orig": "DCA47956",
- "level1_token": "c6b4cd157f4f2dabf3101e7d7b8e34c8",
- "level2_token": "b1ed5c2938dff6afa19f19ececcefb27",
- "workable_at": null,
- "skip_street_date": false,
- "due_at": null,
- "created_at": "2019-08-29T13:33:17-04:00",
- "updated_at": "2019-08-29T13:33:18-04:00",
- "meta_data": null,
- "is_quote": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Erin O'Connell DDS",
- "shipping_company": null,
- "shipping_address_1": "884 Kassulke Ways",
- "shipping_address_2": null,
- "shipping_city": "South Ashli",
- "shipping_state": "Indiana",
- "shipping_zip": "53344",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "shipping_phone": null,
- "email": "ahmednicolas@little.biz",
- "requested_address": "884 Kassulke Ways\nSouth Ashli, Indiana 53344\nUnited States",
- "residential": true,
- "address_verified": true,
- "address_message": ": . : ",
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "customer_provided_label_carrier": null,
- "shipping_vendor": null,
- "shipping_distribution_center": null,
- "shipping_department": null,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": "Whiplash Cheapest Rate",
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6326363,
- "order_id": 2649742,
- "customer_id": 3506,
- "item_id": 1242900,
- "package_id": 2306637,
- "quote_item_id": null,
- "sku": "PTCB-0002",
- "description": "Purple Tektronic Chelsea Boot, Size 2",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2019-08-29T13:33:18-04:00",
- "updated_at": "2019-08-29T13:33:18-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10214006,
- "originated_id": 6326363,
- "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": "2019-08-29T13:33:18-04:00",
- "updated_at": "2019-08-29T13:33:18-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10214005,
- "originated_id": 2649742,
- "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": "2019-08-29T13:33:17-04:00",
- "updated_at": "2019-08-29T13:33:17-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306637,
- "order_id": 2649742,
- "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": "",
- "bill_of_lading": null,
- "created_at": "2019-08-29T13:33:17-04:00",
- "updated_at": "2019-08-29T13:33:17-04:00",
- "ucc128": null,
- "order_item_ids": [
- 6326363
]
}
], - "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-05:00",
- "updated_at": "2015-08-03T16:23:10-04:00"
}, - "serial_numbers": [ ]
}, - {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - {
- "id": 2649766,
- "customer_id": 3515,
- "order_batch_id": 2034,
- "quote_id": null,
- "warehouse_id": 11,
- "return_warehouse_id": 11,
- "shipping_method_id": 37,
- "estimated_shipping_method_id": null,
- "humanize_id": "2649766-SCA22730",
- "status": 300,
- "status_name": "Shipped",
- "previous_status": 160,
- "order_orig": "SCA22730",
- "level1_token": "47709f25a7b8cf8391a55e831fc1d5b9",
- "level2_token": "46fa6e825aaa51f603811b06106b2789",
- "workable_at": "2019-09-10T13:48:37.000-04:00",
- "skip_street_date": false,
- "due_at": "2019-09-11T16:00:00.000-04:00",
- "created_at": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:38.000-04:00",
- "meta_data": null,
- "is_quote": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Gerardo Ullrich",
- "shipping_company": null,
- "shipping_address_1": "15897 Harvey Shoal",
- "shipping_address_2": null,
- "shipping_city": "Port Craigchester",
- "shipping_state": "Wisconsin",
- "shipping_zip": "10527-5506",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "shipping_phone": null,
- "email": "herlindabashirian@aufderhar.co",
- "requested_address": "15897 Harvey Shoal\nPort Craigchester, Wisconsin 10527-5506\nUnited States",
- "residential": true,
- "address_verified": true,
- "address_message": "address: Address not found",
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "customer_provided_label_carrier": null,
- "shipping_vendor": null,
- "shipping_distribution_center": null,
- "shipping_department": null,
- "ship_actual_cost": null,
- "shipped_on": "2019-09-10T12:48:37.000-04:00",
- "ship_notes": null,
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": "Whiplash Cheapest Rate",
- "packingslip_pdf_url": null,
- "tracking": [
- "9408728238414003692185"
], - "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6326398,
- "order_id": 2649766,
- "customer_id": 3515,
- "item_id": 1243235,
- "package_id": 2306660,
- "quote_item_id": null,
- "sku": "SSJIW-0002",
- "description": "Simple Salvage Jeans In White, Size 2",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04: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": false,
- "misc": null,
- "originator": {
- "id": 10214555,
- "originated_id": 6326398,
- "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": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04:00",
- "application_id": null
}
}, - {
- "id": 6326402,
- "order_id": 2649766,
- "customer_id": 3515,
- "item_id": 828641,
- "package_id": 2306660,
- "quote_item_id": null,
- "sku": "S-12661",
- "description": "32X22 KRAFT JUMBO EZFOLD MLR",
- "quantity": 1,
- "price": "5.64",
- "created_at": "2019-09-10T12:48:37.000-04:00",
- "updated_at": "2019-09-10T12:48:37.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10214584,
- "originated_id": 6326402,
- "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": "2019-09-10T12:48:37.000-04:00",
- "updated_at": "2019-09-10T12:48:37.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10214554,
- "originated_id": 2649766,
- "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": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:21.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306660,
- "order_id": 2649766,
- "shipped_on": "2019-09-10T12:48:37.000-04:00",
- "ship_actual_cost": "17.65",
- "actual_weight": null,
- "actual_width": null,
- "actual_height": null,
- "actual_length": null,
- "actual_dimensional_weight": null,
- "tracking": "9408728238414003692185",
- "tracking_link": "",
- "bill_of_lading": null,
- "created_at": "2019-09-10T12:48:21.000-04:00",
- "updated_at": "2019-09-10T12:48:37.000-04:00",
- "ucc128": null,
- "order_item_ids": [
- 6326398,
- 6326402
]
}
], - "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": [ ]
}, - {
- "order": {
- "id": 100026,
- "customer_id": 322,
- "order_batch_id": 13,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": 54,
- "estimated_shipping_method_id": 54,
- "humanize_id": "100026",
- "status": 300,
- "status_name": "Shipped",
- "previous_status": 250,
- "order_orig": null,
- "level1_token": "76007155d462bbf0744e6c8d6ef10155",
- "level2_token": "cdba4d7474d69ea654f9aff5e0911146",
- "workable_at": "2021-09-08T11:59:01.000-04:00",
- "skip_street_date": false,
- "due_at": "2021-09-09T16:00:00.000-04:00",
- "created_at": "2021-09-08T11:58:39.000-04:00",
- "updated_at": "2021-09-08T12:00:06.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "order_type": "direct_to_consumer",
- "email": "bannaelle1@hotmail.com",
- "address_verified": false,
- "items_updateable": false,
- "address_message": "Proposed address varies too greatly from requested address",
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": "2021-04-29T09:26:01.000-04:00",
- "shop_updated_at": null,
- "shop_shipping_method_text": "DHL eCommerce International Direct",
- "shop_shipping_method_price": "0.0",
- "billing_company": null,
- "billing_address_1": "12 impasse Larribau",
- "billing_address_2": null,
- "billing_address_3": null,
- "billing_city": "Biarritz",
- "billing_state": null,
- "billing_zip": "64200",
- "billing_country": "FR",
- "billing_phone": "06 63 26 75 28",
- "billed": true,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Annaëlle Bonnec",
- "shipping_company": null,
- "shipping_address_1": "12 impasse Larribau",
- "shipping_address_2": null,
- "shipping_city": "Biarritz",
- "shipping_state": null,
- "shipping_zip": "64200",
- "shipping_country": "France",
- "shipping_country_iso2": "FR",
- "shipping_phone": "06 63 26 75 28",
- "requested_address": "12 impasse Larribau\nBiarritz 64200\nFrance",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "customs_required": true,
- "ship_actual_cost": "106.44",
- "shipped_on": "2021-09-08T12:00:05.000-04:00",
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": "FedEx International Economy",
- "packingslip_pdf_url": null,
- "customs_vat_number": null,
- "customs_eori_number": null,
- "customs_ioss_number": null,
- "tracking": [
- "794662758610"
], - "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,
- "order_items": [
- {
- "id": 39,
- "order_id": 100026,
- "customer_id": 322,
- "item_id": 8000050,
- "package_id": 27,
- "quote_item_id": null,
- "sku": "the-og-dino",
- "description": "The OG Dino",
- "quantity": 1,
- "price": "5.0",
- "created_at": "2021-09-08T11:58:39.000-04:00",
- "updated_at": "2021-09-08T11:59:09.000-04:00",
- "unshippable": false,
- "available": true,
- "packed": 1,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "request_serial_number": false,
- "originator": {
- "id": 106,
- "originated_id": 39,
- "originated_type": "OrderItem",
- "shop_id": null,
- "provider": "whiplash:manual",
- "original_id": "41211512651939",
- "group_id": null,
- "misc": null,
- "active": true,
- "integration_id": null,
- "last_notified_at": null,
- "last_notification_status": null,
- "distinct_originator_key": null,
- "created_at": "2021-09-08T11:58:39.000-04:00",
- "updated_at": "2021-09-08T11:58:39.000-04:00",
- "application_id": 1
}
}, - {
- "id": 40,
- "order_id": 100026,
- "customer_id": 322,
- "item_id": 8000001,
- "package_id": 27,
- "quote_item_id": null,
- "sku": "S-5147",
- "description": "6X10 ULINE WHT SS BBL MLR #0",
- "quantity": 1,
- "price": "0.27",
- "created_at": "2021-09-08T11:59:11.000-04:00",
- "updated_at": "2021-09-08T11:59:11.000-04: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": false,
- "misc": null,
- "request_serial_number": false,
- "originator": {
- "id": 108,
- "originated_id": 40,
- "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": "2021-09-08T11:59:11.000-04:00",
- "updated_at": "2021-09-08T11:59:11.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 107,
- "originated_id": 100026,
- "originated_type": "Order",
- "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": "2021-09-08T11:58:39.000-04:00",
- "updated_at": "2021-09-08T11:58:39.000-04:00",
- "application_id": 1
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 27,
- "order_id": 100026,
- "shipped_on": "2021-09-08T12:00:02.000-04:00",
- "ship_actual_cost": "106.44",
- "actual_weight": "16.6",
- "actual_width": "6.0",
- "actual_height": "1.0",
- "actual_length": "10.0",
- "actual_dimensional_weight": 0.26666666666666666,
- "tracking": "794662758610",
- "order_item_ids": [
- 39,
- 40
], - "created_at": "2021-09-08T11:58:39.000-04:00",
- "updated_at": "2021-09-08T12:00:02.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null,
- "vics_bill_of_lading": "0000000273",
- "manifest_id": null
}
], - "shipping_method": {
- "id": 54,
- "carrier": "FedEx",
- "service": "INTERNATIONAL_ECONOMY",
- "description": "International Economy",
- "name": "FedEx International Economy",
- "international": true,
- "active": true,
- "flat_rate": false,
- "expedited": false,
- "trackable": true,
- "origins": [
- "US",
- "GB"
], - "extended_description": null,
- "created_at": "2021-07-27T12:18:47.000-04:00",
- "updated_at": "2021-07-27T12:18:47.000-04:00"
}, - "serial_numbers": [ ]
}, - "fees": {
- "pick": "0.0",
- "pack": "2.95",
- "packaging": "0.27",
- "postage": "106.44",
- "total": "109.66",
- "currency": "USD"
}, - "tracking_details": [ ],
- "order_meta_fields": {
- "fob_pay_code": "14375y2hv",
- "shipping_distribution_center": "Ypsilanti",
- "shipping_department": "Produce",
- "shipping_window_opens_on": "2021-09-29T13",
- "shipping_window_closes_on": "2021-09-30T13",
- "purchase_order_date": "2021-09-08T13"
}, - "order_item_meta_fields": [
- {
- "damon_test": "this test works",
- "id": 39,
- "originator_id": "41211512651939"
}, - {
- "id": 40,
- "originator_id": null
}
], - "package_sscc_18_codes": [
- {
- "package_id": 27,
- "sscc_18": "0000000000273"
}
], - "event_name": "order.shipped_package_details"
}
]
Returns count of orders
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created orders.
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
An array of order objects to create in bulk
[- { }
]
{- "result": "string"
}
Returns count of order's events
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
Get the order history
id required | integer <int32> |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "date": "2019-08-24T14:15:22Z",
- "description": "string",
- "event_type": "string",
- "saved_by": "string",
- "saved_via": "string",
- "saved_by_id": 0
}
]
Update an order
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
shipping_method_id | integer <int32> the order shipping method id |
estimated_shipping_method_id | integer <int32> the estimated order shipping method id, if set to cheapest rate |
humanize_id | string the order humanized id |
order_orig | string the order original id (from the shop that sent whiplash the order) |
level1_token | string the order level 1 token |
level2_token | string the order level 2 token |
skip_street_date | boolean skip street date for this order? |
due_at | string <date-time> the order due at date and time |
meta_data | string meta data for this order as stringified JSON |
customer_provided_label_carrier | string the carrier on the customer provided label (for tracking purposes) |
purchase_order | string the purchase order this order |
order_type | string the order type |
string the order shipping email | |
items_updateable | boolean are the items in the order updateable |
skip_address_verification | boolean skip order shipping address verification? (staff only) |
shop_shipping_method_currency | string the order shop shipping method currency |
shop_created_at | string <date-time> the order shop creation date and time |
shop_updated_at | string <date-time> the order shop last update date and time |
shop_shipping_method_text | string the order shop shipping method text |
shop_shipping_method_price | number <float> the order shop shipping method price |
billing_company | string the order billing company |
billing_address_1 | string the order billing street address 1 |
billing_address_2 | string the order billing street address 2 |
billing_address_3 | string the order billing street address 3 |
billing_city | string the order billing city |
billing_state | string the order billing state |
billing_zip | string the order billing zip |
billing_country | string the order billing country |
billing_phone | string the order billing phone number |
do_not_bill | boolean do not bill for the order? (staff only) |
billing_name | string the order billing name |
first_name | string the first name of the person the order is being shipped to |
last_name | string the last name of the person the order is being shipped to |
full_name | string the full name of the person the order is being shipped to |
shipping_name | string the order shipping name |
shipping_company | string the order shipping company |
shipping_address_1 | string the order shipping street address 1 |
shipping_address_2 | string the order shipping street address 2 |
shipping_city | string the order shipping city |
shipping_state | string the order shipping state |
shipping_zip | string the order shipping zip |
shipping_country | string the order shipping country |
shipping_country_iso2 | string the order shipping country iso2 (US, GB, CA, etc) |
shipping_phone | string the order shipping phone number |
requested_address | string the order requested address |
residential | boolean is the order address residential? |
expedited | boolean is the order expedited? |
require_signature | boolean does the order require a signature upon delivery? |
require_adult_signature | boolean does the order require an adult signature upon delivery? |
saturday_delivery | boolean require a carrier that delivers on Saturdays for this order? |
gift | boolean is the order a gift? |
insure | boolean is the order insured? |
contains_alcohol | boolean does the order contain alcohol? |
customs_required | boolean does the order require customs documents? |
shipping_carrier_facility | string carrier facility access point for the address destination |
shipping_hold_for_pickup | boolean pickup option for carrier facility on the address destination |
ship_notes | string the order ship notes |
ship_3rdparty_cost | number <float> the order third party shipping cost |
ship_3rdparty_account | string the order third party shipping account |
ship_3rdparty_zip | string the order third party shipping zip |
ship_3rdparty_country | string the order third party shipping country |
public_note | string the order public note |
days_in_transit | integer <int32> the order estimated days in transit (used for release planning) |
days_in_transit_carrier_estimate | integer <int32> the order estimated days in transit estimate from the carrier |
req_insurance_value | number <float> the order requested insurance value |
packingslip_pdf_url | string url for this orders packing slip |
cf_packingslip_pdf_url | string packingslip pdf url |
customs_vat_number | string Value Added Tax identifcation number for the sender of the order |
customs_eori_number | string Economic Operators Registration and Identification number for the sender of the order |
customs_ioss_number | string Import One-Stop Shop number for the sender of the order |
carrier_account_id | integer <int32> the carrier account id for this package, if it has shipped (staff only) |
approximate_delivery_date | string <date> the order approxiamte delivery date |
global_e_ge_order | boolean is the order a global_e order? |
calculated_time_limit | string the orders calculated return time limit |
within_return_time_limit | boolean is the order within its return time limit |
return_name | string the order return name |
return_company | string the order return company |
return_address_1 | string the order return street address 1 |
return_address_2 | string the order return street address 2 |
return_city | string the order return city |
return_state | string the order return state |
return_country | string the order return country |
return_zip | string the order return zip |
return_phone | string the order return phone number |
return_email | string the order return email |
return_time_limit | integer <int32> the order return time limit |
is_workable | boolean is the order workable? |
is_gestating | boolean is the order gestating? |
permissions_limited | boolean Permission limited orders are not editable, but still may be processed/shipped |
incoterm | string Enum: "EXW" "FCA" "CPT" "CIP" "DAT" "DAP" "DDP" "FAS" "FOB" "CFR" "CIF" "DAF" "DES" "DEQ" "DDU" desired incoterm for the order |
{- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "items_updateable": true,
- "skip_address_verification": true,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_notes": "string",
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "incoterm": "EXW"
}
{- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
Retrieve an order
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
Update Order meta fields
id required | integer <int32> |
fields | object Hash of key/value pairs |
association_fields | object Included meta fields for associations |
{- "fields": { },
- "association_fields": { }
}
{- "message": "string"
}
OrderDocuments are files attached to and order, like a pre-printed shipping label, BOL, etc.
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
url required | string the order document file url |
customer_id | integer <int32> the order document customer id |
{- "url": "string",
- "customer_id": 0
}
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Retrieve all order documents for an order
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
[- {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Create an order item
id required | integer <int32> the order item id |
item_id required | integer <int32> the order item item id |
package_id | integer <int32> the order item package id |
quote_item_id | integer <int32> the order item quote item id |
sku | string the SKU of this item |
description | string description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. |
quantity | integer <int32> number of this item in Order |
price | number <float> price of this item |
unshippable | boolean is this item unshippable? |
available | boolean is this item available? |
packed | integer <int32> number of items packed |
packaging | boolean is this item packaging? |
wholesale_cost | number <float> wholesale cost of the item |
is_bundle | boolean is this item a bundle? |
retail_fee | number <float> retail fee of this item |
promo | boolean is this item a promo? |
returnable | boolean is this item returnable? |
currency | string currency code for this item |
wholesale_fee | number <float> wholesale fee of this item |
hazmat | boolean (deprecated) is the order item hazmat? |
misc | string miscellaneous information about the order item |
request_serial_number | boolean does the item require a serial number when shipping? |
object | |
object Hash of key value pairs (must conform to available meta keys) |
{- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}, - "meta_fields": {
- "fields": { }
}
}
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}
Retrieve all order items for an order
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
fields | string Comma-separated list of fields to include in the response |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
[- {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}
]
Actions can be performed UPON an order. They don't necessarily update the order itself. You can see which actions are available to you at /orders/actions
action required | string |
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
args | object Method params |
{- "args": { }
}
{- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
Serial numbers are scanned and saved during the packing process.
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
Remove an order document from an order
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update an order item
id required | integer <int32> |
order_id | integer <int32> the order item order id |
item_id | integer <int32> the order item item id |
package_id | integer <int32> the order item package id |
quote_item_id | integer <int32> the order item quote item id |
sku | string the SKU of this item |
description | string description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. |
quantity | integer <int32> number of this item in Order |
price | number <float> price of this item |
unshippable | boolean is this item unshippable? |
available | boolean is this item available? |
packed | integer <int32> number of items packed |
packaging | boolean is this item packaging? |
wholesale_cost | number <float> wholesale cost of the item |
is_bundle | boolean is this item a bundle? |
retail_fee | number <float> retail fee of this item |
promo | boolean is this item a promo? |
returnable | boolean is this item returnable? |
currency | string currency code for this item |
wholesale_fee | number <float> wholesale fee of this item |
hazmat | boolean (deprecated) is the order item hazmat? |
misc | string miscellaneous information about the order item |
request_serial_number | boolean does the item require a serial number when shipping? |
{- "order_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true
}
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}
Retrieve an order item
id required | integer <int32> |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}
Update OrderItem meta fields
id required | integer <int32> |
fields | object Hash of key/value pairs |
association_fields | object Included meta fields for associations |
{- "fields": { },
- "association_fields": { }
}
{- "message": "string"
}
Separate an order item into a new order
id required | integer <int32> |
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}
Perform an action on an order_item
action required | string |
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
args | object Method params |
{- "args": { }
}
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}
Serial numbers are scanned and saved during the packing process.
id required | integer <int32> |
[- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
A Shipnotice is the opposite of an order, and are notifications by the client of inventory that is expected to arrive at a warehouse.
Shipnotices represent incoming stock.
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
sender required | string the shipnotice sender |
eta required | string <date-time> the shipnotice estimated arrival date |
warehouse_id required | integer <int32> the shipnotice warehouse id |
status | integer <int32> status of the shipnotice |
status_name | string the shipnotice status name |
received_by | string the name of the person who received the shipnotice |
notes_by_whiplash | string notes by whiplash |
notes_by_customer | string notes by customer |
total_boxes | integer <int32> total number of boxes in the shipnotice |
arrived_at | string <date-time> the shipnotice arrival date and time |
skip_images | boolean allow skipping of images for this shipnotice? |
easypostable_id | string the ID of the easypost shipment or tracker |
easypostable_type | string the type of the easypost object (shipment or tracker) |
shipping_label_url | string url of the shipping label |
ship_actual_cost | number <float> the shipnotice actual cost of shipping |
shipping_method_text | string the method of shipping for the shipnotice |
carrier | string shipping carrier |
shipping_method_id | integer <int32> shipping method id |
tracking | string the tracking number of the shipnotice |
order_id | integer <int32> the order_id of the shipnotice |
type | string shipnotice type (Shipnotice, ConsumerReturn) |
postage_billed | boolean was postage billed? |
handling_billed | boolean was handling billed? |
ship_3rdparty_cost | number <float> 3rd party cost for the shipnotice |
requires_label | boolean does this shipnotice require a label? |
completed_at | string <date-time> the shipnotice completion date and time |
complete_by | string <date-time> the shipnotice must be completed by date and time |
ship_actual_currency | string currency used for this shipnotice |
delivered_at | string <date-time> date when was the shipnoticed delivered |
due_at | string <date-time> date when the shipnotice is due to be delivered |
meta_data | string meta data for this shipnotice as stringified JSON |
reference | string purchase order number or other human readable token to another system |
shipnotice_item_count | integer <int32> number of line items in this Ship Notice |
shipnotice_item_sku_count | integer <int32> number of unique items in this Ship Notice |
shipnotice_item_quantity | integer <int32> quantity of all the line items in this Ship Notice |
purchase_order_numbers | Array of strings purchase order numbers associated with this Ship Notice |
inspection_required | boolean is inspection required? (default: false) |
Array of objects | |
object | |
object Hash of key value pairs (must conform to available meta keys) |
{- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "warehouse_id": 0,
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "order_id": 0,
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "purchase_order_numbers": [
- "string"
], - "inspection_required": true,
- "shipnotice_items_attributes": [
- {
- "quantity": 0,
- "item_id": 0,
- "item_originator_id": "string",
- "purchase_order_number": "string",
- "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}, - "lot_attributes": {
- "number": "string",
- "expires_on": "2019-08-24T14:15:22Z"
}
}
], - "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}, - "meta_fields": {
- "fields": { },
- "association_fields": { }
}
}
{- "id": 181657,
- "customer_id": 3545,
- "warehouse_id": 4,
- "sender": "Gleason, Hane and Kautzer",
- "eta": "2020-10-02T17:03:17.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:18.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:18.000-04:00",
- "due_at": "2020-09-21T16:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 9,
- "shipnotice_item_quantity": 160,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 4,
- "name": "Ypsilanti",
- "timezone": "Eastern Time (US & Canada)",
- "shipping_address_1": "291 Airport Industrial Drive",
- "shipping_address_2": "",
- "shipping_city": "Ypsilanti",
- "shipping_state": "Michigan",
- "shipping_zip": "48198",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 42.2404,
- "longitude": -83.5708
}, - "originator": {
- "id": 10217731,
- "originated_id": 181657,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398511,
- "shipnotice_id": 181657,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "4.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "17.5",
- "width": "20.0",
- "height": "7.5",
- "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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398512,
- "shipnotice_id": 181657,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "7.3",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "18.5",
- "width": "3.5",
- "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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398513,
- "shipnotice_id": 181657,
- "item_id": 1244319,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "0.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.0",
- "width": "10.0",
- "height": "0.5",
- "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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398514,
- "shipnotice_id": 181657,
- "item_id": 1244320,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "2.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "12.0",
- "width": "4.0",
- "height": "10.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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398515,
- "shipnotice_id": 181657,
- "item_id": 1244321,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "8.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "16.0",
- "height": "6.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398516,
- "shipnotice_id": 181657,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "3.5",
- "width": "9.5",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398517,
- "shipnotice_id": 181657,
- "item_id": 1244323,
- "quantity": 50,
- "quantity_good": 50,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "6.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.5",
- "width": "9.0",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398518,
- "shipnotice_id": 181657,
- "item_id": 1244310,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244310,
- "sku": "OSJJ-0012",
- "title": "Orchid Simple Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Simple Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:21.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "2.9",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OSJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "1.5",
- "height": "2.5",
- "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": "Orchid Simple Jean Jacket, Size 12",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398519,
- "shipnotice_id": 181657,
- "item_id": 1244292,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}
]
}
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 837096,
- "customer_id": 6695,
- "warehouse_id": 22,
- "sender": "Ebert, Auer and Boyle",
- "eta": "2019-08-29T16:22:52.000-04:00",
- "status": 300,
- "status_name": "Completed",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:54.000-04:00",
- "arrived_at": "2019-09-26T16:22:53.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": "2019-09-26T16:22:54.000-04:00",
- "ship_actual_currency": null,
- "delivered_at": "2019-09-26T16:22:53.000-04:00",
- "due_at": "2019-09-30T19:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "customer": {
- "id": 6695,
- "name": "Ross 248 Apparel",
- "created_at": "2019-09-26T16:22:47.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": "<html>\n <head>\n <style type=\"text/css\">\n div#headline {\n height: 60px;\n }\n\n body {\n width: 800px;\n margin: 0;\n font: 0.7em/1.1em \"Lucida Grande\", \"DejaVu Sans\", Arial, sans-serif;\n }\n\n h1 {\n font-weight: normal;\n font-size: 18pt;\n line-height: 24pt;\n }\n h4 {\n margin: 0;\n padding: 0;\n }\n\n table {\n border: 0;\n }\n\n tr {\n border: 0;\n }\n\n td {\n vertical-align: top;\n padding-bottom: 8px;\n border: 0;\n }\n td, th {\n border-bottom: solid 1px black;\n }\n\n a {\n text-decoration: none;\n color: #000;\n }\n\n address {\n font-style: normal;\n }\n\n .page {\n page-break-inside: avoid;\n position: relative;\n }\n\n #customer_logo {\n clear: none;\n float: right;\n }\n\n .headroom {\n margin-top: 50px;\n }\n\n .legroom {\n margin-bottom: 50px;\n }\n\n tr.headroom td {\n padding-top: 50px;\n }\n\n tr.mini-headroom td {\n padding-top: 25px;\n }\n\n tr.micro-headroom td {\n padding-top: 10px;\n }\n\n .label {\n margin-bottom: 5px;\n font-size: 1.4em;\n font-style: bold;\n }\n\n .center {\n text-align: center;\n margin-left: auto;\n margin-right: auto;\n border: 0;\n }\n\n .left{\n text-align: left;\n }\n\n .right {\n text-align: right;\n }\n\n #date {\n margin-top: -10px;\n }\n\n #addresses {\n clear: none;\n }\n\n #support, #public-note {\n padding-top: 100px;\n }\n\n #public-note {\n font-size: 125%;\n line-height: 125%;\n border: 1px solid #000;\n padding: 10px;\n margin-top: 50px;\n }\n </style>\n </head>\n\n <body>\n <div class=\"page\">\n <!-- Order Number -->\n <div id=\"headline\">\n <h1>Packing Slip for Order {{ order.number }}</h1>\n </div>\n\n <div class=\"row\">\n <!-- Customer Logo -->\n {% if customer.logo? %}\n <div id=\"customer_logo\">\n {{ customer.logo }}\n </div>\n {% endif %}\n\n <!-- Billing/Shipping Address -->\n <div class=\"headroom\" id=\"addresses\">\n <div id=\"date\"> Order Date: {{ order.date }} </div>\n <br />\n <h4>From:</h4>\n <address>\n <strong>{{ customer.name }}</strong><br />\n </address>\n <br />\n <h4>To:</h4>\n <address>\n {{ order.address }}\n </address>\n </div>\n </div>\n\n <br clear=\"right\" />\n\n <div class=\"headroom\">\n <h3 id=\"ship-method\">{{ order.ship_method }}</h3>\n </div>\n\n <div id=\"order-items\">\n <div id=\"items\">\n <table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"100%\" class=\"table table-striped table-bordered\">\n <tr>\n <th class=\"left\">Item Sku</th>\n <th class=\"left\">Desc</th>\n <th class=\"left\">Qty</th>\n </tr>\n {% for order_item in order.order_items %}\n <tr>\n <td class=\"item_row left\">{{ order_item.sku }}</td>\n <td class=\"item_row left\">{{ order_item.description }}</td>\n <td class=\"item_row left\">{{ order_item.quantity }}</td>\n </tr>\n {% endfor %}\n </table>\n </div>\n </div>\n\n\n {% if order.notes? %}\n <div class=\"center\" id=\"public-note\">\n <p>{{ order.notes }}</p>\n </div>\n {% endif %}\n\n <div id=\"support\" class=\"center\">\n Thank you for your order!\n </div>\n </div>\n </body>\n</html>\n",
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Ross 248 Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2019-09-26T16:22:53.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "authentication_token": "44NFZ3pJoBs3rcLPx4D6",
- "billing_email": "ilsebechtelar@sauer.info",
- "billing_contact_name": "Milton Baines",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "61956 Boris Cove",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "North Salena",
- "billing_state": "Arkansas",
- "billing_zip": "76386",
- "billing_country": "United States",
- "billing_residential": null,
- "items_returnable": 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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": "If you have any questions send us an email. Thanks for your support! - Ross 248 Apparel",
- "email_confirmation_preference": 1,
- "email_confirmation_template": "<html>\n <head>\n <title>A message from Whiplash</title>\n <meta name=\"viewport\" content=\"width=696\" />\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <style media=\"only screen and (max-device-width: 480px)\" type=\"text/css\">\n * {line-height: normal !important}\n </style>\n <style type=\"text/css\">\n a {text-decoration:none; color:#5b7ab3;}\n a:hover {text-decoration:underline; color:#5b7ab3;}\n ul {list-style-type: none; padding: 0 20;}\n\n .shipping-address {margin-left: 20px;}\n </style>\n\n </head>\n\n <body>\n <p class=\"greeting\">Hello {{order.greeting}}!</p>\n\n <p>We just shipped your order via {{ order.ship_method }}. We hope you love it. Here's what we shipped:</p>\n\n <ul class=\"order-items\">\n {% for order_item in order.order_items %}\n <li>{{ order_item.quantity }} x {{ order_item.description }}</li>\n {% endfor %}\n </ul>\n\n <p>And here's where we shipped it:</p>\n\n <div class=\"shipping-address\">\n {{ order.shipping_address }}\n </div>\n\n <p class=\"tracking\">\n {% if order.tracking_numbers.size > 1 %}\n Your order was shipped in multiple packages. Your tracking numbers are:\n {{ order.tracking_links }}\n {% elsif order.tracking_numbers.size == 1 %}\n Your tracking number is: {{ order.tracking_link }}\n {% endif %}\n </p>\n\n <p class=\"salutation\">If you have any questions send us an email. Thanks for your support! -{{ customer.name }}</p>\n </body>\n</html>\n",
- "low_inventory_threshold": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 1,
- "items_unavailable_on_sellout": false,
- "replenishment_min": null,
- "replenishment_target": null
}, - "warehouse": {
- "id": 22,
- "name": "Mira Loma",
- "timezone": "Pacific Time (US & Canada)",
- "shipping_address_1": "10314 Birtcher Drive",
- "shipping_address_2": "",
- "shipping_city": "Mira Loma",
- "shipping_state": "California",
- "shipping_zip": "91752",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 34.0061,
- "longitude": -117.512
}, - "originator": {
- "id": 22625412,
- "originated_id": 837096,
- "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": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:52.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 801005,
- "shipnotice_id": 837096,
- "item_id": 2548989,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:53.000-04:00",
- "item": {
- "id": 2548989,
- "sku": "JC-0002",
- "title": "Jaguar Cardigan",
- "description": "Size 2",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:56.000-04:00",
- "customer_id": 6695,
- "quantity": 59,
- "weight": "8.0",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "20.0",
- "width": "17.0",
- "height": "5.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": "Jaguar Cardigan, Size 2",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 59
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}, - {
- "id": 801006,
- "shipnotice_id": 837096,
- "item_id": 2548990,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:53.000-04:00",
- "item": {
- "id": 2548990,
- "sku": "JC-0004",
- "title": "Jaguar Cardigan",
- "description": "Size 4",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:56.000-04:00",
- "customer_id": 6695,
- "quantity": 51,
- "weight": "9.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.0",
- "width": "6.0",
- "height": "10.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": "Jaguar Cardigan, Size 4",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 51
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}, - {
- "id": 801007,
- "shipnotice_id": 837096,
- "item_id": 2548991,
- "quantity": 10,
- "quantity_good": 9,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:54.000-04:00",
- "item": {
- "id": 2548991,
- "sku": "JC-0006",
- "title": "Jaguar Cardigan",
- "description": "Size 6",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:56.000-04:00",
- "customer_id": 6695,
- "quantity": 59,
- "weight": "8.4",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "14.5",
- "width": "13.5",
- "height": "16.5",
- "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": "Jaguar Cardigan, Size 6",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 59
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}, - {
- "id": 801008,
- "shipnotice_id": 837096,
- "item_id": 2548992,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:54.000-04:00",
- "item": {
- "id": 2548992,
- "sku": "JC-0008",
- "title": "Jaguar Cardigan",
- "description": "Size 8",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:57.000-04:00",
- "customer_id": 6695,
- "quantity": 120,
- "weight": "2.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "15.5",
- "width": "14.5",
- "height": "15.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": "Jaguar Cardigan, Size 8",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 120
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}, - {
- "id": 801009,
- "shipnotice_id": 837096,
- "item_id": 2548993,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:54.000-04:00",
- "item": {
- "id": 2548993,
- "sku": "JC-0010",
- "title": "Jaguar Cardigan",
- "description": "Size 10",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:57.000-04:00",
- "customer_id": 6695,
- "quantity": 59,
- "weight": "1.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.5",
- "width": "7.5",
- "height": "4.5",
- "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": "Jaguar Cardigan, Size 10",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 59
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}, - {
- "id": 801010,
- "shipnotice_id": 837096,
- "item_id": 2548994,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:54.000-04:00",
- "item": {
- "id": 2548994,
- "sku": "JC-0012",
- "title": "Jaguar Cardigan",
- "description": "Size 12",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:57.000-04:00",
- "customer_id": 6695,
- "quantity": 79,
- "weight": "9.0",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "10.0",
- "width": "7.5",
- "height": "2.5",
- "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": "Jaguar Cardigan, Size 12",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 79
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}, - {
- "id": 801011,
- "shipnotice_id": 837096,
- "item_id": 2548995,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2019-09-26T16:22:52.000-04:00",
- "updated_at": "2019-09-26T16:22:54.000-04:00",
- "item": {
- "id": 2548995,
- "sku": "JC-0014",
- "title": "Jaguar Cardigan",
- "description": "Size 14",
- "original_location": null,
- "created_at": "2019-09-26T16:22:50.000-04:00",
- "updated_at": "2019-09-26T16:22:57.000-04:00",
- "customer_id": 6695,
- "quantity": 89,
- "weight": "6.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "00JC0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "14.0",
- "width": "6.0",
- "height": "2.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": "Jaguar Cardigan, Size 14",
- "image_url": null,
- "hazmat": false,
- "misc": null,
- "ean": null,
- "lot_control": false,
- "expiration_period": null,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": null,
- "carton_quantity": null,
- "origin_country": null,
- "replenishment_min": null,
- "replenishment_target": null,
- "low_inventory_threshold": null,
- "published_quantity": 89
}, - "lot": null,
- "warehouse_id": 22,
- "unallocated": 0
}
]
}, - {
- "id": 181657,
- "customer_id": 3545,
- "warehouse_id": 4,
- "sender": "Gleason, Hane and Kautzer",
- "eta": "2020-10-02T17:03:17.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:18.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:18.000-04:00",
- "due_at": "2020-09-21T16:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 9,
- "shipnotice_item_quantity": 160,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 4,
- "name": "Ypsilanti",
- "timezone": "Eastern Time (US & Canada)",
- "shipping_address_1": "291 Airport Industrial Drive",
- "shipping_address_2": "",
- "shipping_city": "Ypsilanti",
- "shipping_state": "Michigan",
- "shipping_zip": "48198",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 42.2404,
- "longitude": -83.5708
}, - "originator": {
- "id": 10217731,
- "originated_id": 181657,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398511,
- "shipnotice_id": 181657,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "4.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "17.5",
- "width": "20.0",
- "height": "7.5",
- "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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398512,
- "shipnotice_id": 181657,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "7.3",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "18.5",
- "width": "3.5",
- "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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398513,
- "shipnotice_id": 181657,
- "item_id": 1244319,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "0.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.0",
- "width": "10.0",
- "height": "0.5",
- "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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398514,
- "shipnotice_id": 181657,
- "item_id": 1244320,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "2.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "12.0",
- "width": "4.0",
- "height": "10.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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398515,
- "shipnotice_id": 181657,
- "item_id": 1244321,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "8.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "16.0",
- "height": "6.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398516,
- "shipnotice_id": 181657,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "3.5",
- "width": "9.5",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398517,
- "shipnotice_id": 181657,
- "item_id": 1244323,
- "quantity": 50,
- "quantity_good": 50,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "6.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.5",
- "width": "9.0",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398518,
- "shipnotice_id": 181657,
- "item_id": 1244310,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244310,
- "sku": "OSJJ-0012",
- "title": "Orchid Simple Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Simple Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:21.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "2.9",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OSJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "1.5",
- "height": "2.5",
- "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": "Orchid Simple Jean Jacket, Size 12",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398519,
- "shipnotice_id": 181657,
- "item_id": 1244292,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}
]
}, - {
- "id": 181656,
- "customer_id": 3545,
- "warehouse_id": 6,
- "sender": "Ruecker-Ullrich",
- "eta": "2020-09-07T17:03:17.000-04:00",
- "status": 200,
- "status_name": "Processing",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:30.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:30.000-04:00",
- "due_at": "2020-09-21T19:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 7,
- "shipnotice_item_quantity": 110,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 6,
- "name": "Reno",
- "timezone": "Pacific Time (US & Canada)",
- "shipping_address_1": "742 Spice Islands Dr",
- "shipping_address_2": "",
- "shipping_city": "Sparks",
- "shipping_state": "Nevada",
- "shipping_zip": "89431",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 39.5139,
- "longitude": -119.73
}, - "originator": {
- "id": 10217723,
- "originated_id": 181656,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398504,
- "shipnotice_id": 181656,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 11,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "5.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "2.0",
- "width": "0.5",
- "height": "14.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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 1
}, - {
- "id": 398505,
- "shipnotice_id": 181656,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "3.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "15.5",
- "width": "9.5",
- "height": "14.5",
- "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": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398506,
- "shipnotice_id": 181656,
- "item_id": 1244319,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "7.2",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "1.5",
- "width": "11.5",
- "height": "17.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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398507,
- "shipnotice_id": 181656,
- "item_id": 1244320,
- "quantity": 10,
- "quantity_good": 11,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "3.0",
- "height": "8.5",
- "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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398508,
- "shipnotice_id": 181656,
- "item_id": 1244321,
- "quantity": 20,
- "quantity_good": 22,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "5.0",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "14.0",
- "width": "14.0",
- "height": "10.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 4
}, - {
- "id": 398509,
- "shipnotice_id": 181656,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 9,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.0",
- "width": "19.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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398510,
- "shipnotice_id": 181656,
- "item_id": 1244323,
- "quantity": 30,
- "quantity_good": 33,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "14.0",
- "height": "20.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 3
}
]
}, - {
- "id": 181657,
- "customer_id": 3545,
- "warehouse_id": 4,
- "sender": "Gleason, Hane and Kautzer",
- "eta": "2020-10-02T17:03:17.000-04:00",
- "status": 25,
- "status_name": "Unexpected",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:18.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:18.000-04:00",
- "due_at": "2020-09-21T16:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 9,
- "shipnotice_item_quantity": 160,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 4,
- "name": "Ypsilanti",
- "timezone": "Eastern Time (US & Canada)",
- "shipping_address_1": "291 Airport Industrial Drive",
- "shipping_address_2": "",
- "shipping_city": "Ypsilanti",
- "shipping_state": "Michigan",
- "shipping_zip": "48198",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 42.2404,
- "longitude": -83.5708
}, - "originator": {
- "id": 10217731,
- "originated_id": 181657,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398511,
- "shipnotice_id": 181657,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "4.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "17.5",
- "width": "20.0",
- "height": "7.5",
- "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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398512,
- "shipnotice_id": 181657,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "7.3",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "18.5",
- "width": "3.5",
- "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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398513,
- "shipnotice_id": 181657,
- "item_id": 1244319,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "0.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.0",
- "width": "10.0",
- "height": "0.5",
- "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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398514,
- "shipnotice_id": 181657,
- "item_id": 1244320,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "2.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "12.0",
- "width": "4.0",
- "height": "10.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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398515,
- "shipnotice_id": 181657,
- "item_id": 1244321,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "8.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "16.0",
- "height": "6.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398516,
- "shipnotice_id": 181657,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "3.5",
- "width": "9.5",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398517,
- "shipnotice_id": 181657,
- "item_id": 1244323,
- "quantity": 50,
- "quantity_good": 50,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "6.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.5",
- "width": "9.0",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398518,
- "shipnotice_id": 181657,
- "item_id": 1244310,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244310,
- "sku": "OSJJ-0012",
- "title": "Orchid Simple Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Simple Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:21.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "2.9",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OSJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "1.5",
- "height": "2.5",
- "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": "Orchid Simple Jean Jacket, Size 12",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398519,
- "shipnotice_id": 181657,
- "item_id": 1244292,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}
]
}, - {
- "id": 398510,
- "shipnotice_id": 181656,
- "item_id": 1244323,
- "quantity": 30,
- "quantity_good": 33,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "14.0",
- "height": "20.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 3
}, - {
- "id": 398510,
- "shipnotice_id": 181656,
- "item_id": 1244323,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:18.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "6.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.5",
- "width": "9.0",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}
]
Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created shipnotices.
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
An array of shipnotice objects to create in bulk
[- { }
]
{- "result": "string"
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "order_id": 0,
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "customer": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}, - "warehouse": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "purchase_order_numbers": [
- null
], - "inspection_required": true,
- "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "shipnotice_items": [
- {
- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
]
}
NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
customer_id | integer <int32> the shipnotice customer id |
sender | string the shipnotice sender |
eta | string <date-time> the shipnotice estimated arrival date |
status | integer <int32> status of the shipnotice |
status_name | string the shipnotice status name |
received_by | string the name of the person who received the shipnotice |
notes_by_whiplash | string notes by whiplash |
notes_by_customer | string notes by customer |
total_boxes | integer <int32> total number of boxes in the shipnotice |
arrived_at | string <date-time> the shipnotice arrival date and time |
skip_images | boolean allow skipping of images for this shipnotice? |
easypostable_id | string the ID of the easypost shipment or tracker |
easypostable_type | string the type of the easypost object (shipment or tracker) |
shipping_label_url | string url of the shipping label |
ship_actual_cost | number <float> the shipnotice actual cost of shipping |
shipping_method_text | string the method of shipping for the shipnotice |
carrier | string shipping carrier |
shipping_method_id | integer <int32> shipping method id |
tracking | string the tracking number of the shipnotice |
type | string shipnotice type (Shipnotice, ConsumerReturn) |
postage_billed | boolean was postage billed? |
handling_billed | boolean was handling billed? |
ship_3rdparty_cost | number <float> 3rd party cost for the shipnotice |
requires_label | boolean does this shipnotice require a label? |
completed_at | string <date-time> the shipnotice completion date and time |
complete_by | string <date-time> the shipnotice must be completed by date and time |
ship_actual_currency | string currency used for this shipnotice |
delivered_at | string <date-time> date when was the shipnoticed delivered |
due_at | string <date-time> date when the shipnotice is due to be delivered |
meta_data | string meta data for this shipnotice as stringified JSON |
reference | string purchase order number or other human readable token to another system |
shipnotice_item_count | integer <int32> number of line items in this Ship Notice |
shipnotice_item_sku_count | integer <int32> number of unique items in this Ship Notice |
shipnotice_item_quantity | integer <int32> quantity of all the line items in this Ship Notice |
shipnotice_items | string |
{- "customer_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "shipnotice_items": "string"
}
{- "id": 181657,
- "customer_id": 3545,
- "warehouse_id": 4,
- "sender": "Gleason, Hane and Kautzer",
- "eta": "2020-10-02T17:03:17.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:18.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:18.000-04:00",
- "due_at": "2020-09-21T16:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 9,
- "shipnotice_item_quantity": 160,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 4,
- "name": "Ypsilanti",
- "timezone": "Eastern Time (US & Canada)",
- "shipping_address_1": "291 Airport Industrial Drive",
- "shipping_address_2": "",
- "shipping_city": "Ypsilanti",
- "shipping_state": "Michigan",
- "shipping_zip": "48198",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 42.2404,
- "longitude": -83.5708
}, - "originator": {
- "id": 10217731,
- "originated_id": 181657,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398511,
- "shipnotice_id": 181657,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "4.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "17.5",
- "width": "20.0",
- "height": "7.5",
- "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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398512,
- "shipnotice_id": 181657,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "7.3",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "18.5",
- "width": "3.5",
- "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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398513,
- "shipnotice_id": 181657,
- "item_id": 1244319,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "0.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.0",
- "width": "10.0",
- "height": "0.5",
- "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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398514,
- "shipnotice_id": 181657,
- "item_id": 1244320,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "2.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "12.0",
- "width": "4.0",
- "height": "10.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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398515,
- "shipnotice_id": 181657,
- "item_id": 1244321,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "8.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "16.0",
- "height": "6.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398516,
- "shipnotice_id": 181657,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "3.5",
- "width": "9.5",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398517,
- "shipnotice_id": 181657,
- "item_id": 1244323,
- "quantity": 50,
- "quantity_good": 50,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "6.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.5",
- "width": "9.0",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398518,
- "shipnotice_id": 181657,
- "item_id": 1244310,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244310,
- "sku": "OSJJ-0012",
- "title": "Orchid Simple Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Simple Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:21.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "2.9",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OSJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "1.5",
- "height": "2.5",
- "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": "Orchid Simple Jean Jacket, Size 12",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398519,
- "shipnotice_id": 181657,
- "item_id": 1244292,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}
]
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 181656,
- "customer_id": 3545,
- "warehouse_id": 6,
- "sender": "Ruecker-Ullrich",
- "eta": "2020-09-07T17:03:17.000-04:00",
- "status": 200,
- "status_name": "Processing",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:30.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:30.000-04:00",
- "due_at": "2020-09-21T19:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 7,
- "shipnotice_item_quantity": 110,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 6,
- "name": "Reno",
- "timezone": "Pacific Time (US & Canada)",
- "shipping_address_1": "742 Spice Islands Dr",
- "shipping_address_2": "",
- "shipping_city": "Sparks",
- "shipping_state": "Nevada",
- "shipping_zip": "89431",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 39.5139,
- "longitude": -119.73
}, - "originator": {
- "id": 10217723,
- "originated_id": 181656,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398504,
- "shipnotice_id": 181656,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 11,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "5.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "2.0",
- "width": "0.5",
- "height": "14.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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 1
}, - {
- "id": 398505,
- "shipnotice_id": 181656,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "3.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "15.5",
- "width": "9.5",
- "height": "14.5",
- "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": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398506,
- "shipnotice_id": 181656,
- "item_id": 1244319,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "7.2",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "1.5",
- "width": "11.5",
- "height": "17.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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398507,
- "shipnotice_id": 181656,
- "item_id": 1244320,
- "quantity": 10,
- "quantity_good": 11,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "3.0",
- "height": "8.5",
- "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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398508,
- "shipnotice_id": 181656,
- "item_id": 1244321,
- "quantity": 20,
- "quantity_good": 22,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "5.0",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "14.0",
- "width": "14.0",
- "height": "10.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 4
}, - {
- "id": 398509,
- "shipnotice_id": 181656,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 9,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.0",
- "width": "19.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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398510,
- "shipnotice_id": 181656,
- "item_id": 1244323,
- "quantity": 30,
- "quantity_good": 33,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "14.0",
- "height": "20.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 3
}
]
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
quantity required | integer <int32> the number of this shipnotice item in the shipnotice |
item_id required | integer <int32> the shipnotice item item id |
return_action | string action to perform on item return |
description | string description of the item |
extended_description | string an extended description of the item |
include_in_published | boolean include this item in published amount? |
purchase_order_number | string the purchase order number associated with the shipnotice item |
location_role | string the location role into which the item is received. options: pickable (default), damaged, pending, backstock (staff only) |
object | |
object | |
object Hash of key value pairs (must conform to available meta keys) |
{- "quantity": 0,
- "item_id": 0,
- "return_action": "string",
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "purchase_order_number": "string",
- "location_role": "string",
- "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}, - "lot_attributes": {
- "number": "string",
- "expires_on": "2019-08-24"
}, - "meta_fields": {
- "fields": { }
}
}
{- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
[- {
- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
]
Update Shipnotice meta fields
id required | integer <int32> |
fields | object Hash of key/value pairs |
association_fields | object Included meta fields for associations |
{- "fields": { },
- "association_fields": { }
}
{- "message": "string"
}
id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
{- "count": 0
}
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
Similar to an OrderItem, ShipnoticeItem represents an Item with a quantity in a Shipnotice. quantity refers to the quantity expected to arrive, and the quantity actually received is quantity_good.
{- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
id required | integer <int32> |
quantity | integer <int32> the number of this shipnotice item in the shipnotice |
description | string description of the item |
extended_description | string an extended description of the item |
include_in_published | boolean include this item in published amount? |
purchase_order_number | string the purchase order number associated with the shipnotice item |
location_role | string the location role into which the item is received. options: pickable (default), damaged, pending, backstock (staff only) |
{- "quantity": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "purchase_order_number": "string",
- "location_role": "string"
}
{- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
{- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
Update ShipnoticeItem meta fields
id required | integer <int32> |
fields | object Hash of key/value pairs |
association_fields | object Included meta fields for associations |
{- "fields": { },
- "association_fields": { }
}
{- "message": "string"
}
A ConsumerReturn represents goods coming back from an end consumer. It is a special form of Shipnotice, and is processed in much the same way.
Update ConsumerReturn meta fields
id required | integer <int32> |
fields | object Hash of key/value pairs |
association_fields | object Included meta fields for associations |
{- "fields": { },
- "association_fields": { }
}
{- "message": "string"
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
sender | string the consumer return sender |
eta | string <date-time> the consumer return estimated arrival date |
tracking | string the tracking number of the consumer return |
notes_by_customer | string notes by customer |
shipping_label_url | string url of the shipping label |
total_boxes | integer <int32> total number of boxes in the consumer return |
shipping_method_text | string the method of shipping for the consumer return |
carrier | string shipping carrier |
requires_label | boolean does this consumer return require a label? |
ship_3rdparty_cost | number <float> 3rd party cost for the consumer return |
reference | string purchase order number or other human readable token to another system |
{- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "tracking": "string",
- "notes_by_customer": "string",
- "shipping_label_url": "string",
- "total_boxes": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "requires_label": true,
- "ship_3rdparty_cost": 0,
- "reference": "string"
}
{- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
id | integer <int32> the consumer return id |
order_id required | integer <int32> The whiplash id of the order from which an item is being returned |
customer_id | integer <int32> the consumer return customer id |
warehouse_id | integer <int32> The ID of the whiplash warehouse this return should be delivered to |
sender | string the consumer return sender |
eta | string <date-time> the consumer return estimated arrival date |
status | integer <int32> status of the consumer return |
status_name | string the shipnotice status name |
received_by | string the name of the person who received the consumer return |
notes_by_whiplash | string notes by whiplash |
notes_by_customer | string notes by customer |
total_boxes | integer <int32> total number of boxes in the consumer return |
created_at | string <date-time> the consumer return creation date and time |
updated_at | string <date-time> the consumer return last update date and time |
arrived_at | string <date-time> the consumer return arrival date and time |
skip_images | boolean allow skipping of images for this consumer return? |
easypostable_id | string the ID of the easypost shipment or tracker |
easypostable_type | string the type of the easypost object (shipment or tracker) |
shipping_label_url | string url of the shipping label |
ship_actual_cost | number <float> the consumer return actual cost of shipping |
shipping_method_text | string the method of shipping for the consumer return |
carrier | string shipping carrier |
tracking | string the tracking number of the consumer return |
type | string consumer return type (Shipnotice, ConsumerReturn) |
postage_billed | boolean was postage billed? |
handling_billed | boolean was handling billed? |
ship_3rdparty_cost | number <float> the consumer return actual cost of shipping |
requires_label required | boolean does this consumer return require a label? |
completed_at | string <date-time> the consumer return completion date and time |
ship_actual_currency | string currency used for this consumer return |
delivered_at | string <date-time> date when was the consumer return delivered |
due_at | string <date-time> date when the consumer return is due to be delivered |
reference | string purchase order number or other human readable token to another system |
Array of objects | |
object | |
object Hash of key value pairs (must conform to available meta keys) | |
exchange_items | Array of integers <int32> [ items <int32 > ] List of whiplash item ids to be added to an exchange order |
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "tracking": "string",
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "shipnotice_items_attributes": [
- {
- "item_id": 0,
- "quantity": 0,
- "return_action": "string",
- "description": "string",
- "extended_description": "string",
- "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}
}
], - "originator_attributes": {
- "original_id": "string",
- "group_id": "string",
- "misc": "string"
}, - "meta_fields": {
- "fields": { },
- "association_fields": { }
}, - "exchange_items": [
- 0
]
}
{- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 300,
- "status_name": "Completed",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:32.000-04:00",
- "arrived_at": "2020-09-16T17:03:31.000-04: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": "2020-09-16T17:03:32.000-04:00",
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:31.000-04:00",
- "due_at": "2020-09-21T16:00:00.000-04:00",
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 1,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}, - {
- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}, - {
- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 25,
- "status_name": "Unexpected",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}
]
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
An array of consumer_return objects to create in bulk
[- { }
]
{- "result": "string"
}
Originators are e-commerce, API, or ERP representations of an Item, Order, OrderItem, ConsumerReturn, Shipnotice, or ShipnoticeItem. They contain your system's ID and, optionally, details.
You can use your own ID to retrieve, update, and destroy resources directly.
Update an order
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
shipping_method_id | integer <int32> the order shipping method id |
estimated_shipping_method_id | integer <int32> the estimated order shipping method id, if set to cheapest rate |
humanize_id | string the order humanized id |
order_orig | string the order original id (from the shop that sent whiplash the order) |
level1_token | string the order level 1 token |
level2_token | string the order level 2 token |
skip_street_date | boolean skip street date for this order? |
due_at | string <date-time> the order due at date and time |
meta_data | string meta data for this order as stringified JSON |
customer_provided_label_carrier | string the carrier on the customer provided label (for tracking purposes) |
purchase_order | string the purchase order this order |
order_type | string the order type |
string the order shipping email | |
items_updateable | boolean are the items in the order updateable |
skip_address_verification | boolean skip order shipping address verification? (staff only) |
shop_shipping_method_currency | string the order shop shipping method currency |
shop_created_at | string <date-time> the order shop creation date and time |
shop_updated_at | string <date-time> the order shop last update date and time |
shop_shipping_method_text | string the order shop shipping method text |
shop_shipping_method_price | number <float> the order shop shipping method price |
billing_company | string the order billing company |
billing_address_1 | string the order billing street address 1 |
billing_address_2 | string the order billing street address 2 |
billing_address_3 | string the order billing street address 3 |
billing_city | string the order billing city |
billing_state | string the order billing state |
billing_zip | string the order billing zip |
billing_country | string the order billing country |
billing_phone | string the order billing phone number |
do_not_bill | boolean do not bill for the order? (staff only) |
billing_name | string the order billing name |
first_name | string the first name of the person the order is being shipped to |
last_name | string the last name of the person the order is being shipped to |
full_name | string the full name of the person the order is being shipped to |
shipping_name | string the order shipping name |
shipping_company | string the order shipping company |
shipping_address_1 | string the order shipping street address 1 |
shipping_address_2 | string the order shipping street address 2 |
shipping_city | string the order shipping city |
shipping_state | string the order shipping state |
shipping_zip | string the order shipping zip |
shipping_country | string the order shipping country |
shipping_country_iso2 | string the order shipping country iso2 (US, GB, CA, etc) |
shipping_phone | string the order shipping phone number |
requested_address | string the order requested address |
residential | boolean is the order address residential? |
expedited | boolean is the order expedited? |
require_signature | boolean does the order require a signature upon delivery? |
require_adult_signature | boolean does the order require an adult signature upon delivery? |
saturday_delivery | boolean require a carrier that delivers on Saturdays for this order? |
gift | boolean is the order a gift? |
insure | boolean is the order insured? |
contains_alcohol | boolean does the order contain alcohol? |
customs_required | boolean does the order require customs documents? |
shipping_carrier_facility | string carrier facility access point for the address destination |
shipping_hold_for_pickup | boolean pickup option for carrier facility on the address destination |
ship_notes | string the order ship notes |
ship_3rdparty_cost | number <float> the order third party shipping cost |
ship_3rdparty_account | string the order third party shipping account |
ship_3rdparty_zip | string the order third party shipping zip |
ship_3rdparty_country | string the order third party shipping country |
public_note | string the order public note |
days_in_transit | integer <int32> the order estimated days in transit (used for release planning) |
days_in_transit_carrier_estimate | integer <int32> the order estimated days in transit estimate from the carrier |
req_insurance_value | number <float> the order requested insurance value |
packingslip_pdf_url | string url for this orders packing slip |
cf_packingslip_pdf_url | string packingslip pdf url |
customs_vat_number | string Value Added Tax identifcation number for the sender of the order |
customs_eori_number | string Economic Operators Registration and Identification number for the sender of the order |
customs_ioss_number | string Import One-Stop Shop number for the sender of the order |
carrier_account_id | integer <int32> the carrier account id for this package, if it has shipped (staff only) |
approximate_delivery_date | string <date> the order approxiamte delivery date |
global_e_ge_order | boolean is the order a global_e order? |
calculated_time_limit | string the orders calculated return time limit |
within_return_time_limit | boolean is the order within its return time limit |
return_name | string the order return name |
return_company | string the order return company |
return_address_1 | string the order return street address 1 |
return_address_2 | string the order return street address 2 |
return_city | string the order return city |
return_state | string the order return state |
return_country | string the order return country |
return_zip | string the order return zip |
return_phone | string the order return phone number |
return_email | string the order return email |
return_time_limit | integer <int32> the order return time limit |
is_workable | boolean is the order workable? |
is_gestating | boolean is the order gestating? |
permissions_limited | boolean Permission limited orders are not editable, but still may be processed/shipped |
incoterm | string Enum: "EXW" "FCA" "CPT" "CIP" "DAT" "DAP" "DDP" "FAS" "FOB" "CFR" "CIF" "DAF" "DES" "DEQ" "DDU" desired incoterm for the order |
{- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "items_updateable": true,
- "skip_address_verification": true,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_notes": "string",
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "incoterm": "EXW"
}
{- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
Retrieve an order
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 100,
- "status_name": "Processing",
- "previous_status": 100,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
An item may have many alternate scancodes
originator_id required | integer <int32> |
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "item_id": 0,
- "primary": true,
- "customer_id": 0,
- "name": "string",
- "scancode": "string",
- "active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "label_format": "string"
}
]
Retrieve the quantity of this item in each warehouse in which it has stock
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string",
- "quantity": 0,
- "projected_quantity": 0,
- "sellable_quantity": 0
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "parent_item_id": 0,
- "item_id": 0,
- "bundle_id": 0,
- "quantity": 0,
- "max_per_package": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "message": "string"
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
sku | string the item SKU number |
title | string the item title |
description | string the item description |
full_description | string the full item description |
customer_id | integer <int32> the id of the customer the item belongs to |
quantity | integer <int32> the available quantity of the item |
weight | number <float> the weight of the item (in pounds) |
available | boolean is the item available? |
image_originator_url | string the originator url for the item image |
vendor | string the item vendor |
scancode | string the item scancode |
price | number <float> the item price |
media_mail | boolean is the item eligible for media mail? |
packaging | boolean is the item packaging? |
length | number <float> the item length (in inches) |
width | number <float> the item width (in inches) |
height | number <float> the item height (in inches) |
active | boolean is the item active? |
wholesale_cost | number <float> the wholesale cost of the item |
is_bundle | boolean is the item a bundle? |
packaging_type | string Enum: "WhiplashBag" "WhiplashBox" "WhiplashBubbleMailer" "WhiplashFill" "WhiplashFlat" "WhiplashTube" "WhiplashNoPackaging" "WhiplashPallet" "Card" "Letter" "Flat" "Parcel" "LargeParcel" "IrregularParcel" "FlatRateEnvelope" "FlatRateLegalEnvelope" "FlatRatePaddedEnvelope" "FlatRateGiftCardEnvelope" "FlatRateWindowEnvelope" "FlatRateCardboardEnvelope" "SmallFlatRateEnvelope" "SmallFlatRateBox" "MediumFlatRateBox" "LargeFlatRateBox" "RegionalRateBoxA" "RegionalRateBoxB" "RegionalRateBoxC" "LargeFlatRateBoardGameBox" "UPSLetter" "UPSExpressBox" "UPS25kgBox" "UPS10kgBox" "Tube" "Pak" "Pallet" "SmallExpressBox" "MediumExpressBox" "LargeExpressBox" "FedExEnvelope" "FedExBox" "FedExPak" "FedExTube" "FedEx10kgBox" "FedEx25kgBox" "BPM" "LargeLetter" "SmallParcel" "MediumParcel" the item packaging type |
promo | boolean is the item a promo? |
street_date | string <date-time> the item street date |
category | string the item category |
include_inbound_in_published | boolean include inbound items in published? |
returnable | boolean is the item returnable? |
return_sku_match | string the item return SKU match |
return_price_restricted | boolean is the item return price restricted? |
request_serial_number | boolean does the item require a serial number when shipping? |
currency | string the item currency |
tariff_number | string the item harmonized tariff number (for international shipping) |
notify_originator_inventory | integer <int32> notify originator inventory? |
name | string the item name and description, formatted nicely |
hazmat | boolean (deprecated) is the item hazmat? |
hazmat_type | string Enum: "ormd" "lithium" "ORMD" "LITHIUM" hazmat class |
misc | string miscellaneous information about the item |
ean | string the EAN number for the item |
lot_control | boolean does this item require lot control? |
expiration_period | integer <int32> items that are this many days from expiration will not be allowed to ship |
ship_strategy | integer <int32> which locations to pick first: Default, FIFO, FEFO |
velocity | integer <int32> Average number of units expected to sell in a day |
case_quantity | integer <int32> How many of this item to a case? |
carton_quantity | integer <int32> How many CASES to a carton? |
origin_country | string Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "PS" "OM" "PK" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" The country of origin for this item (as an iso2 country code) |
alcohol | boolean Does this order contain alcohol? |
shippable_container | boolean Is this item a shippable container? |
replenishment_min | number <float> Minimum number of days worth of stock to keep in forward pick locations |
replenishment_target | number <float> Target number of days stock to replenish forward pick locations |
low_inventory_threshold | integer <int32> the item quantity where this item would be considered having low inventory |
published_quantity | integer <int32> item quantity, inluding inbound items |
{- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "order_id": 0,
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "customer": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}, - "warehouse": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "purchase_order_numbers": [
- null
], - "inspection_required": true,
- "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "shipnotice_items": [
- {
- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
]
}
NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
customer_id | integer <int32> the shipnotice customer id |
sender | string the shipnotice sender |
eta | string <date-time> the shipnotice estimated arrival date |
status | integer <int32> status of the shipnotice |
status_name | string the shipnotice status name |
received_by | string the name of the person who received the shipnotice |
notes_by_whiplash | string notes by whiplash |
notes_by_customer | string notes by customer |
total_boxes | integer <int32> total number of boxes in the shipnotice |
arrived_at | string <date-time> the shipnotice arrival date and time |
skip_images | boolean allow skipping of images for this shipnotice? |
easypostable_id | string the ID of the easypost shipment or tracker |
easypostable_type | string the type of the easypost object (shipment or tracker) |
shipping_label_url | string url of the shipping label |
ship_actual_cost | number <float> the shipnotice actual cost of shipping |
shipping_method_text | string the method of shipping for the shipnotice |
carrier | string shipping carrier |
shipping_method_id | integer <int32> shipping method id |
tracking | string the tracking number of the shipnotice |
type | string shipnotice type (Shipnotice, ConsumerReturn) |
postage_billed | boolean was postage billed? |
handling_billed | boolean was handling billed? |
ship_3rdparty_cost | number <float> 3rd party cost for the shipnotice |
requires_label | boolean does this shipnotice require a label? |
completed_at | string <date-time> the shipnotice completion date and time |
complete_by | string <date-time> the shipnotice must be completed by date and time |
ship_actual_currency | string currency used for this shipnotice |
delivered_at | string <date-time> date when was the shipnoticed delivered |
due_at | string <date-time> date when the shipnotice is due to be delivered |
meta_data | string meta data for this shipnotice as stringified JSON |
reference | string purchase order number or other human readable token to another system |
shipnotice_item_count | integer <int32> number of line items in this Ship Notice |
shipnotice_item_sku_count | integer <int32> number of unique items in this Ship Notice |
shipnotice_item_quantity | integer <int32> quantity of all the line items in this Ship Notice |
shipnotice_items | string |
{- "customer_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "shipnotice_items": "string"
}
{- "id": 181657,
- "customer_id": 3545,
- "warehouse_id": 4,
- "sender": "Gleason, Hane and Kautzer",
- "eta": "2020-10-02T17:03:17.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:18.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:18.000-04:00",
- "due_at": "2020-09-21T16:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 9,
- "shipnotice_item_quantity": 160,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 4,
- "name": "Ypsilanti",
- "timezone": "Eastern Time (US & Canada)",
- "shipping_address_1": "291 Airport Industrial Drive",
- "shipping_address_2": "",
- "shipping_city": "Ypsilanti",
- "shipping_state": "Michigan",
- "shipping_zip": "48198",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 42.2404,
- "longitude": -83.5708
}, - "originator": {
- "id": 10217731,
- "originated_id": 181657,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398511,
- "shipnotice_id": 181657,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "4.8",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "17.5",
- "width": "20.0",
- "height": "7.5",
- "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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398512,
- "shipnotice_id": 181657,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "7.3",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "18.5",
- "width": "3.5",
- "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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398513,
- "shipnotice_id": 181657,
- "item_id": 1244319,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "0.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "4.0",
- "width": "10.0",
- "height": "0.5",
- "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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398514,
- "shipnotice_id": 181657,
- "item_id": 1244320,
- "quantity": 30,
- "quantity_good": 30,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "2.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "12.0",
- "width": "4.0",
- "height": "10.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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398515,
- "shipnotice_id": 181657,
- "item_id": 1244321,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "8.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "16.0",
- "height": "6.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398516,
- "shipnotice_id": 181657,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.5",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "3.5",
- "width": "9.5",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398517,
- "shipnotice_id": 181657,
- "item_id": 1244323,
- "quantity": 50,
- "quantity_good": 50,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:20.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "6.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.5",
- "width": "9.0",
- "height": "2.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398518,
- "shipnotice_id": 181657,
- "item_id": 1244310,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244310,
- "sku": "OSJJ-0012",
- "title": "Orchid Simple Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Simple Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:21.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "2.9",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OSJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "1.5",
- "height": "2.5",
- "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": "Orchid Simple Jean Jacket, Size 12",
- "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": 29
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}, - {
- "id": 398519,
- "shipnotice_id": 181657,
- "item_id": 1244292,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:19.000-04:00",
- "item": {
- "id": 1244292,
- "sku": "ST-0004",
- "title": "Simple Twill",
- "description": "Size 4",
- "full_description": "Simple Twill, Size 4",
- "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
}, - "lot": null,
- "warehouse_id": 4,
- "unallocated": 0
}
]
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 181656,
- "customer_id": 3545,
- "warehouse_id": 6,
- "sender": "Ruecker-Ullrich",
- "eta": "2020-09-07T17:03:17.000-04:00",
- "status": 200,
- "status_name": "Processing",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "arrived_at": "2020-09-16T17:03:30.000-04: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": null,
- "order_id": null,
- "type": "Shipnotice",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": "2020-09-16T17:03:30.000-04:00",
- "due_at": "2020-09-21T19:00:00.000-04:00",
- "meta_data": null,
- "reference": null,
- "shipnotice_item_count": 7,
- "shipnotice_item_quantity": 110,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 6,
- "name": "Reno",
- "timezone": "Pacific Time (US & Canada)",
- "shipping_address_1": "742 Spice Islands Dr",
- "shipping_address_2": "",
- "shipping_city": "Sparks",
- "shipping_state": "Nevada",
- "shipping_zip": "89431",
- "shipping_country": "United States",
- "shipping_country_iso2": "US",
- "latitude": 39.5139,
- "longitude": -119.73
}, - "originator": {
- "id": 10217723,
- "originated_id": 181656,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "shipping_method": null,
- "shipnotice_items": [
- {
- "id": 398504,
- "shipnotice_id": 181656,
- "item_id": 1244324,
- "quantity": 10,
- "quantity_good": 11,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244324,
- "sku": "OAJJ-0012",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 12",
- "full_description": "Orchid Atlantis Jean Jacket, Size 12",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 40,
- "weight": "5.1",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0012",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "2.0",
- "width": "0.5",
- "height": "14.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": "Orchid Atlantis Jean Jacket, Size 12",
- "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": 40
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 1
}, - {
- "id": 398505,
- "shipnotice_id": 181656,
- "item_id": 1244325,
- "quantity": 10,
- "quantity_good": 10,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244325,
- "sku": "OAJJ-0014",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 14",
- "full_description": "Orchid Atlantis Jean Jacket, Size 14",
- "original_location": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 47,
- "weight": "3.7",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0014",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "15.5",
- "width": "9.5",
- "height": "14.5",
- "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": "Orchid Atlantis Jean Jacket, Size 14",
- "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": 47
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398506,
- "shipnotice_id": 181656,
- "item_id": 1244319,
- "quantity": 20,
- "quantity_good": 20,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244319,
- "sku": "OAJJ-0002",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 2",
- "full_description": "Orchid Atlantis Jean Jacket, Size 2",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 41,
- "weight": "7.2",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0002",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "1.5",
- "width": "11.5",
- "height": "17.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": "Orchid Atlantis Jean Jacket, Size 2",
- "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": 41
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398507,
- "shipnotice_id": 181656,
- "item_id": 1244320,
- "quantity": 10,
- "quantity_good": 11,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244320,
- "sku": "OAJJ-0004",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 4",
- "full_description": "Orchid Atlantis Jean Jacket, Size 4",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 60,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0004",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "6.5",
- "width": "3.0",
- "height": "8.5",
- "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": "Orchid Atlantis Jean Jacket, 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": 60
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398508,
- "shipnotice_id": 181656,
- "item_id": 1244321,
- "quantity": 20,
- "quantity_good": 22,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244321,
- "sku": "OAJJ-0006",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 6",
- "full_description": "Orchid Atlantis Jean Jacket, Size 6",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 48,
- "weight": "5.0",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0006",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "14.0",
- "width": "14.0",
- "height": "10.5",
- "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": "Orchid Atlantis Jean Jacket, Size 6",
- "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": 48
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 4
}, - {
- "id": 398509,
- "shipnotice_id": 181656,
- "item_id": 1244322,
- "quantity": 10,
- "quantity_good": 9,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "item": {
- "id": 1244322,
- "sku": "OAJJ-0008",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 8",
- "full_description": "Orchid Atlantis Jean Jacket, Size 8",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:30.000-04:00",
- "customer_id": 3545,
- "quantity": 29,
- "weight": "9.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0008",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "13.0",
- "width": "19.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": 0,
- "name": "Orchid Atlantis Jean Jacket, Size 8",
- "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": 29
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 0
}, - {
- "id": 398510,
- "shipnotice_id": 181656,
- "item_id": 1244323,
- "quantity": 30,
- "quantity_good": 33,
- "quantity_damaged": 0,
- "description": null,
- "extended_description": null,
- "include_in_published": false,
- "return_action": null,
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "item": {
- "id": 1244323,
- "sku": "OAJJ-0010",
- "title": "Orchid Atlantis Jean Jacket",
- "description": "Size 10",
- "full_description": "Orchid Atlantis Jean Jacket, Size 10",
- "original_location": null,
- "created_at": "2020-09-16T17:03:16.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "customer_id": 3545,
- "quantity": 89,
- "weight": "4.6",
- "available": true,
- "image_originator_url": null,
- "vendor": null,
- "scancode": "OAJJ0010",
- "price": "0.0",
- "media_mail": false,
- "packaging": false,
- "length": "5.5",
- "width": "14.0",
- "height": "20.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": "Orchid Atlantis Jean Jacket, Size 10",
- "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": 89
}, - "lot": null,
- "warehouse_id": 6,
- "unallocated": 3
}
]
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "message": "string"
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
sender | string the consumer return sender |
eta | string <date-time> the consumer return estimated arrival date |
tracking | string the tracking number of the consumer return |
notes_by_customer | string notes by customer |
shipping_label_url | string url of the shipping label |
total_boxes | integer <int32> total number of boxes in the consumer return |
shipping_method_text | string the method of shipping for the consumer return |
carrier | string shipping carrier |
requires_label | boolean does this consumer return require a label? |
ship_3rdparty_cost | number <float> 3rd party cost for the consumer return |
reference | string purchase order number or other human readable token to another system |
{- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "tracking": "string",
- "notes_by_customer": "string",
- "shipping_label_url": "string",
- "total_boxes": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "requires_label": true,
- "ship_3rdparty_cost": 0,
- "reference": "string"
}
{- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}
originator_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 181660,
- "order_id": 2650031,
- "customer_id": 3545,
- "warehouse_id": 1,
- "sender": "Joanne Mraz",
- "eta": "2020-09-30T17:03:31.000-04:00",
- "status": 100,
- "status_name": "In Transit",
- "received_by": null,
- "notes_by_whiplash": null,
- "notes_by_customer": null,
- "total_boxes": 1,
- "created_at": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04: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,
- "tracking": null,
- "type": "ConsumerReturn",
- "postage_billed": null,
- "handling_billed": null,
- "ship_3rdparty_cost": null,
- "requires_label": true,
- "completed_at": null,
- "ship_actual_currency": null,
- "delivered_at": null,
- "due_at": null,
- "reference": null,
- "customer": {
- "id": 3545,
- "name": "Kreb-Full-o Apparel",
- "created_at": "2020-09-16T17:03:13.000-04: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": 0,
- "originator_permissions": false,
- "packing_slip_msg": null,
- "packingslip_template": null,
- "request_serial_numbers": false,
- "ship_method_preference": 0,
- "shipping_name": "Kreb-Full-o Apparel",
- "ups_account": null,
- "vat_number": null,
- "ein": null,
- "warehouse_fallback": 0,
- "payment_hold": true,
- "account_level": 200,
- "account_level_name": null,
- "whitelisted_warehouses": [
- {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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
}
], - "activated_at": "2020-09-16T17:03:18.000-04:00",
- "deactivated_at": null,
- "auto_merge_skus": false,
- "billing_email": "dongtorphy@boehm.co",
- "billing_contact_name": "Biff Tannen",
- "billing_company": null,
- "billing_phone1": null,
- "billing_phone2": null,
- "billing_address1": "36554 Joaquin Bypass",
- "billing_address2": null,
- "billing_address3": null,
- "billing_city": "Prosaccoborough",
- "billing_state": "South Carolina",
- "billing_zip": "82722",
- "billing_country": "United States",
- "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": "support@whiplash.com",
- "email_confirmation_name": "Whiplash Merch",
- "email_confirmation_msg": null,
- "email_confirmation_preference": 1,
- "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
}, - "warehouse": {
- "id": 1,
- "name": "Ann Arbor",
- "timezone": "Eastern Time (US & Canada)",
- "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": 10217762,
- "originated_id": 181660,
- "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": "2020-09-16T17:03:31.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "application_id": null
}, - "return_items": [
- {
- "id": 398534,
- "item_id": 1244320,
- "name": "Orchid Atlantis Jean Jacket, Size 4",
- "sku": "OAJJ-0004",
- "price": "0.0",
- "quantity": 1,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "Defective",
- "extended_description": null,
- "return_action": "exchange",
- "order_item_id": 6327196,
- "return_item_originator_id": null,
- "originator_id": null,
- "lot_ids": [ ]
}
], - "exchange_order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}, - "order": {
- "id": 2650031,
- "customer_id": 3545,
- "order_batch_id": null,
- "quote_id": null,
- "warehouse_id": 1,
- "return_warehouse_id": 1,
- "shipping_method_id": null,
- "estimated_shipping_method_id": null,
- "humanize_id": "2650031-KA11982",
- "status": 430,
- "status_name": "Exchanged",
- "previous_status": 350,
- "order_orig": "KA11982",
- "level1_token": "2da3b2a9fcefb88315c55c2aeaa332db",
- "level2_token": "25ba76e38a12056440d59f4251a17154",
- "workable_at": "2020-09-16T18:03:17.000-04:00",
- "skip_street_date": false,
- "due_at": "2020-09-17T16:00:00.000-04:00",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:31.000-04:00",
- "meta_data": null,
- "customer_provided_label_carrier": null,
- "purchase_order": null,
- "email": "williehane@borer.co",
- "address_verified": true,
- "address_message": null,
- "shop_warehouse_ids": [ ],
- "shop_shipping_method_currency": null,
- "shop_created_at": null,
- "shop_updated_at": null,
- "shop_shipping_method_text": null,
- "shop_shipping_method_price": "0.0",
- "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,
- "billed": false,
- "billing_name": null,
- "first_name": null,
- "last_name": null,
- "full_name": null,
- "shipping_name": "Joanne Mraz",
- "shipping_company": null,
- "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,
- "requested_address": "54295 O'Connell Lakes\nSouth Claritaton, Georgia 46735\nUnited States",
- "residential": true,
- "require_signature": false,
- "require_adult_signature": false,
- "saturday_delivery": false,
- "gift": false,
- "insure": false,
- "contains_alcohol": false,
- "ship_actual_cost": null,
- "shipped_on": null,
- "ship_notes": null,
- "shipping_confirmation_sent": false,
- "ship_3rdparty_cost": "0.0",
- "ship_3rdparty_account": null,
- "ship_3rdparty_zip": null,
- "ship_3rdparty_country": null,
- "incoterm": null,
- "public_note": null,
- "days_in_transit": 1,
- "days_in_transit_carrier_estimate": null,
- "req_insurance_value": null,
- "ship_method": null,
- "packingslip_pdf_url": null,
- "tracking": [ ],
- "tracking_links": [
- ""
], - "approximate_delivery_date": null,
- "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,
- "order_items": [
- {
- "id": 6327196,
- "order_id": 2650031,
- "customer_id": 3545,
- "item_id": 1244320,
- "package_id": 2306939,
- "quote_item_id": null,
- "sku": "OAJJ-0004",
- "description": "Orchid Atlantis Jean Jacket, Size 4",
- "quantity": 1,
- "price": "0.0",
- "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "unshippable": false,
- "available": false,
- "packed": 0,
- "packaging": false,
- "wholesale_cost": null,
- "is_bundle": false,
- "retail_fee": null,
- "promo": false,
- "returnable": null,
- "currency": "USD",
- "wholesale_fee": null,
- "hazmat": false,
- "misc": null,
- "originator": {
- "id": 10217716,
- "originated_id": 6327196,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}
}
], - "originator": {
- "id": 10217715,
- "originated_id": 2650031,
- "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": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "application_id": null
}, - "proto_originator_id": null,
- "packages": [
- {
- "id": 2306939,
- "order_id": 2650031,
- "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": [
- 6327196
], - "created_at": "2020-09-16T17:03:17.000-04:00",
- "updated_at": "2020-09-16T17:03:17.000-04:00",
- "ucc128": null,
- "ship_actual_currency": null
}
], - "shipping_method": null,
- "serial_numbers": [ ]
}
}
search | string JSON search string like {"attribute_eq": "Term"} |
sort | string A list of sort options (ex: name asc,created_at desc) |
originated_type required | string which resource originators you want |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
]
You can create custom Meta Keys that allow you to pass in arbitrary data while still validating keys and format. Additionally, these may be used in Rules and Searches.
Customers are Whiplash clients, not the End Consumer. Most Whiplash resources are owned by a Customer (or belong to resources that are).
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
[- {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}
]
Update your customers' information and preferences
id required | integer <int32> |
workday_uuid | string |
partner_id | integer <int32> Customer partner id. (admins only) |
billing_contact_name | string Customer billing contact name. |
name | string Customer name. |
active | boolean Customer active? |
auto_merge_gestation | integer <int32> Customer auto merge gestation. |
default_warehouse_id | integer <int32> Customer default warehouse id. |
eori_number | string Customer EORI number. |
estimated_monthly_volume | string Customer estimated monthly volume. |
fedex_account | string Customer FedEx account. |
from_email | string Customer from email. |
instructions | string Customer instructions. |
item_scanning_preference | boolean Customer has item scanning preference? |
label_format | string Customer label format. |
notes | string Customer notes. |
notify_originator | boolean notify originator? |
notify_originator_inventory | integer <int32> Customer notify originator inventory. |
originator_permissions | boolean originator permissions? |
packing_slip_msg | string Customer packing slip message. |
packingslip_template | string Customer packing slip template. |
request_serial_numbers | boolean request serial numbers? |
ship_method_preference | integer <int32> Customer shipping method preference. |
shipping_name | string Customer shipping name. |
ups_account | string Customer UPS account. |
vat_number | string Customer VAT number. |
ein | string Customer EIN / Tax ID |
warehouse_fallback | integer <int32> Customer warehouse fallback. |
payment_hold | boolean is this account on hold pending a valid payment method? |
exit_notice | boolean is this account flagged for exit notice? (admins only) |
account_level | integer <int32> Account level |
account_level_name | string Quote, Direct, Enterprise, or Managed |
auto_merge_skus | boolean auto merge SKUs? |
billing_email | string Customer billing email. |
billing_company | string Customer billing company. |
billing_phone1 | string Customer phone 1. |
billing_phone2 | string Customer phone 2. |
billing_address1 | string Customer billing address line 1. |
billing_address2 | string Customer billing address line 2. |
billing_address3 | string Customer billing address line 3. |
billing_city | string Customer billing city. |
billing_state | string Customer billing state. |
billing_zip | string Customer billing zip. |
billing_country | string Customer billing country. |
billing_residential | boolean Customer billing residential? |
items_returnable | boolean items returnable by default? |
allow_international_returns | boolean Allow International returns? |
items_exchangeable | boolean items exchangeable by default? |
return_time_limit | integer <int32> Return time limit. |
return_label_expires_in | integer <int32> Return label expiration time limit. |
return_price_restricted | boolean limit exchange to same value or less? |
return_sku_match | string Exchange SKU match policy. |
rma_display_logo | boolean display customer logo on returns page? |
rma_footer_content | string Return page footer content. |
return_name | string Customer return name. |
return_company | string Customer return company. |
return_email | string Customer return email. |
return_phone | string Customer return phone. |
return_address_1 | string Customer return address line 1. |
return_address_2 | string Customer return address line 2. |
return_city | string Customer return city. |
return_state | string Customer return state. |
return_zip | string Customer return zip. |
return_country | string Customer return country. |
supports_return_labels | boolean does the customer support return labels? |
logo_content_type | string Customer logo content type. |
logo_file_name | string Customer logo file name. |
logo_file_size | integer <int32> Customer logo file size. |
logo_updated_at | string <date-time> Customer logo updated at. |
full_logo_url | string Customer full logo url. |
email_confirmation_from | string Customer email confirmation from. |
email_confirmation_name | string Customer email confirmation name. |
email_confirmation_msg | string Customer email confirmation message. |
email_confirmation_preference | integer <int32> Customer email confirmation preference. |
email_confirmation_template | string Customer email confirmation template. |
low_inventory_threshold | integer <int32> Quantity where an item in inventory would be considered having low inventory |
lot_control | boolean do items for this customer require lot control? |
expiration_period | integer <int32> items that are this many days from expiration will not be allowed to ship |
ship_strategy | integer <int32> which locations to pick first: Default, FIFO, FEFO |
items_unavailable_on_sellout | integer <int32> Process Orders setting: Whiplash will automatically turn on Process Orders when an item is received, and turn it off when an item sells. Whiplash will not manage Process Orders. Whiplash will automatically turn on Process Orders only the first time an Item is received. |
replenishment_min | number <float> Minimum number of days worth of stock to keep in forward pick locations |
replenishment_target | number <float> Target number of days stock to replenish forward pick locations |
location_default_return_role | string Default role (i.e. Pickable, Damaged) for returned items |
location_enable_pending_returns | boolean Allow "pending" role for returned items |
{- "workday_uuid": "string",
- "partner_id": 0,
- "billing_contact_name": "string",
- "name": "string",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "account_level": 0,
- "account_level_name": "string",
- "auto_merge_skus": true,
- "billing_email": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}
Documents are imported files and exported reports. We store a record in your account of every file you import, as well as every report you've run, so they're easy to search and access.
X-Customer-Id | string The customer associated with this resource. |
url | string the document file url |
partner_id | integer <int32> the document partner id |
owner_id | integer <int32> the document owners id |
owner_type | string the document owner type |
customer_name | string associated customer name |
partner_name | string associated partner name |
user_name | string associated user name |
keyword_list | string Comma seperated list of keyword tags |
message_list | string Comma seperated list of message tags |
context_list | string Comma seperated list of context tags |
resource_type_list | string Comma seperated list resource_type tags |
{- "url": "string",
- "partner_id": 0,
- "owner_id": 0,
- "owner_type": "string",
- "customer_name": "string",
- "partner_name": "string",
- "user_name": "string",
- "keyword_list": "string",
- "message_list": "string",
- "context_list": "string",
- "resource_type_list": "string"
}
{- "id": 0,
- "url": "string",
- "user_id": 0,
- "customer_id": 0,
- "partner_id": 0,
- "owner_id": 0,
- "owner_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "keyword_list": "string",
- "message_list": "string",
- "context_list": "string",
- "resource_type_list": "string",
- "customer_name": "string",
- "partner_name": "string",
- "user_name": "string"
}
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
tagged_with | string A comma separated list of tags to search on (ex: "account transaction,AccountExporters::Invoice"). |
[- {
- "id": 0,
- "url": "string",
- "user_id": 0,
- "customer_id": 0,
- "partner_id": 0,
- "owner_id": 0,
- "owner_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "keyword_list": "string",
- "message_list": "string",
- "context_list": "string",
- "resource_type_list": "string",
- "customer_name": "string",
- "partner_name": "string",
- "user_name": "string"
}
]
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
{- "id": 0,
- "url": "string",
- "user_id": 0,
- "customer_id": 0,
- "partner_id": 0,
- "owner_id": 0,
- "owner_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "keyword_list": "string",
- "message_list": "string",
- "context_list": "string",
- "resource_type_list": "string",
- "customer_name": "string",
- "partner_name": "string",
- "user_name": "string"
}
{- "id": 0,
- "url": "string",
- "user_id": 0,
- "customer_id": 0,
- "partner_id": 0,
- "owner_id": 0,
- "owner_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "keyword_list": "string",
- "message_list": "string",
- "context_list": "string",
- "resource_type_list": "string",
- "customer_name": "string",
- "partner_name": "string",
- "user_name": "string"
}
You can subscribe to E-mail, web hook, and sms Notifications for a wide variety of events in the lifecycle of resources like Orders, Shipnotices, and Items. This gives you realtime access to updated data, without the need to poll the API.
There are a wide variety of events you may subscribe to, and we add new ones periodically. You can grab a complete list at any time.
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
[- {
- "id": 0,
- "name": "string",
- "humanized_name": "string",
- "resource_type": "string",
- "resource_message": "string",
- "requires_subscription": true,
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
{- "id": 0,
- "name": "string",
- "humanized_name": "string",
- "resource_type": "string",
- "resource_message": "string",
- "requires_subscription": true,
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Subscribe to an e-mail, web hook, or sms notification for a specified event
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
notification_type | string the type of notification to send the subscriber |
notification_event_id | integer <int32> the id of the notification event this subscription is subscribed to |
endpoint | string the URL the subscription will hit for Slack and Webhook types |
customer_id | integer <int32> the id of the customer who owns the subscription |
user_id | integer <int32> the id of the intended recipient |
active | boolean is the notification subscription active? |
version | integer <int32> whether the payload will match the v1 or v2 API |
{- "notification_type": "string",
- "notification_event_id": 0,
- "endpoint": "string",
- "customer_id": 0,
- "user_id": 0,
- "active": true,
- "version": 0
}
{- "id": 0,
- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "email": "string",
- "sign_in_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "role": "admin",
- "locale": "en",
- "warehouse_id": 0,
- "partner_id": 0,
- "active": true,
- "customer_ids": 0,
- "create_email": true,
- "skip_confirmation": true,
- "auth_token": "string"
}
}
E-mail, web hook, and sms notifications you have subscribed to
search | string JSON search string like {"attribute_eq": "Term"} |
fields | string Comma-separated list of fields to include in the response |
sort | string A list of sort options (ex: name asc,created_at desc) |
page | integer <int32> Default: 1 Page of results to fetch. |
per_page | integer <int32> Default: 25 Number of results to return per page. |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
[- {
- "id": 0,
- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "email": "string",
- "sign_in_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "role": "admin",
- "locale": "en",
- "warehouse_id": 0,
- "partner_id": 0,
- "active": true,
- "customer_ids": 0,
- "create_email": true,
- "skip_confirmation": true,
- "auth_token": "string"
}
}
]
Get a count of notification subscriptions
search | string JSON search string like {"attribute_eq": "Term"} |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "count": 0
}
Send yourself a test e-mail, web hook, or sms message
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "email": "string",
- "sign_in_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "role": "admin",
- "locale": "en",
- "warehouse_id": 0,
- "partner_id": 0,
- "active": true,
- "customer_ids": 0,
- "create_email": true,
- "skip_confirmation": true,
- "auth_token": "string"
}
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "email": "string",
- "sign_in_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "role": "admin",
- "locale": "en",
- "warehouse_id": 0,
- "partner_id": 0,
- "active": true,
- "customer_ids": 0,
- "create_email": true,
- "skip_confirmation": true,
- "auth_token": "string"
}
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
notification_event_id | integer <int32> the id of the notification event this subscription is subscribed to |
customer_id | integer <int32> the id of the customer who owns the subscription |
user_id | integer <int32> the id of the intended recipient |
notification_type | string the type of notification to send the subscriber |
endpoint | string the URL the subscription will hit for Slack and Webhook types |
active | boolean is the notification subscription active? |
version | integer <int32> whether the payload will match the v1 or v2 API |
{- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0
}
{- "id": 0,
- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "email": "string",
- "sign_in_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "role": "admin",
- "locale": "en",
- "warehouse_id": 0,
- "partner_id": 0,
- "active": true,
- "customer_ids": 0,
- "create_email": true,
- "skip_confirmation": true,
- "auth_token": "string"
}
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
X-Shop-Id | string The shop associated with this resource. |
{- "id": 0,
- "notification_event_id": 0,
- "customer_id": 0,
- "user_id": 0,
- "notification_type": "string",
- "endpoint": "string",
- "active": true,
- "version": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "user": {
- "id": 0,
- "email": "string",
- "sign_in_count": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "role": "admin",
- "locale": "en",
- "warehouse_id": 0,
- "partner_id": 0,
- "active": true,
- "customer_ids": 0,
- "create_email": true,
- "skip_confirmation": true,
- "auth_token": "string"
}
}
id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
{- "id": 0,
- "name": "string",
- "template_type_id": 0,
- "content": "string",
- "customer_id": 0,
- "default": true,
- "customizable": true,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "slug": "string",
- "template_type": {
- "id": 0,
- "name": "string",
- "display_name": "string",
- "slug": 0,
- "resource_type": "string",
- "format": "string",
- "accessibility": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
id required | integer <int32> |
name | string Name of the template |
content | string Content of the template |
{- "name": "string",
- "content": "string"
}
{- "id": 0,
- "name": "string",
- "template_type_id": 0,
- "content": "string",
- "customer_id": 0,
- "default": true,
- "customizable": true,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "slug": "string",
- "template_type": {
- "id": 0,
- "name": "string",
- "display_name": "string",
- "slug": 0,
- "resource_type": "string",
- "format": "string",
- "accessibility": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
{- "id": 0,
- "name": "string",
- "template_type_id": 0,
- "content": "string",
- "customer_id": 0,
- "default": true,
- "customizable": true,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "slug": "string",
- "template_type": {
- "id": 0,
- "name": "string",
- "display_name": "string",
- "slug": 0,
- "resource_type": "string",
- "format": "string",
- "accessibility": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
X-Customer-Id | string The customer associated with this resource. |
name required | string Name of the template |
template_type_id required | integer <int32> ID of the template type |
content required | string Content of the template |
default | boolean Is the default template |
{- "name": "string",
- "template_type_id": 0,
- "content": "string",
- "default": true
}
{- "id": 0,
- "name": "string",
- "template_type_id": 0,
- "content": "string",
- "customer_id": 0,
- "default": true,
- "customizable": true,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "slug": "string",
- "template_type": {
- "id": 0,
- "name": "string",
- "display_name": "string",
- "slug": 0,
- "resource_type": "string",
- "format": "string",
- "accessibility": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
search | string JSON search string like {"attribute_eq": "Term"} |
[- {
- "id": 0,
- "name": "string",
- "template_type_id": 0,
- "content": "string",
- "customer_id": 0,
- "default": true,
- "customizable": true,
- "url": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "slug": "string",
- "template_type": {
- "id": 0,
- "name": "string",
- "display_name": "string",
- "slug": 0,
- "resource_type": "string",
- "format": "string",
- "accessibility": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
(Sandbox Only) Simulate Order and Ship Notice processing, since these are staff-only operations.
Customer users don't have access to staff actions, so this simulates a consumer return's workflow, allowing you to process a consumer return and, optionally, finalize it.
consumer_return_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
finalize | boolean Default: true Finalize this ConsumerReturn |
{- "finalize": true
}
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "tracking": "string",
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "return_items": {
- "id": 0,
- "item_id": 0,
- "name": "string",
- "sku": "string",
- "price": "string",
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "return_action": "string",
- "order_item_id": 0,
- "return_item_originator_id": 0,
- "originator_id": 0,
- "lot_ids": 0
}, - "exchange_order": {
- "id": 0,
- "customer_id": 0,
- "order_batch_id": 0,
- "quote_id": 0,
- "warehouse_id": 0,
- "return_warehouse_id": 0,
- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "status": 0,
- "status_name": "string",
- "previous_status": 0,
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "workable_at": "2019-08-24T14:15:22Z",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "address_verified": true,
- "items_updateable": true,
- "skip_address_verification": true,
- "address_message": "string",
- "shop_warehouse_ids": 0,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "billed": true,
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "incoterm": "EXW",
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_actual_cost": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_notes": "string",
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "ship_method": "string",
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": "string",
- "tracking_links": "string",
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_address_verified": true,
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "order_items": {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}, - "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "proto_originator_id": "string",
- "packages": [
- {
- "id": 0,
- "order_id": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_actual_cost": 0,
- "actual_weight": 0,
- "actual_width": 0,
- "actual_height": 0,
- "actual_length": 0,
- "actual_dimensional_weight": 0,
- "tracking": "string",
- "tracking_link": "string",
- "order_item_ids": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ucc128": "string",
- "ship_actual_currency": "string",
- "vics_bill_of_lading": "string",
- "manifest_id": 0,
- "batch_id": 0,
- "shipping_label_url": "string",
- "shipment_id": "string",
- "scan_form_url": "string",
- "shipment_created_at": "2019-08-24T14:15:22Z",
- "shipment_updated_at": "2019-08-24T14:15:22Z",
- "contents_label_printed_at": "2019-08-24T14:15:22Z",
- "shipping_label_printed_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "serial_numbers": [
- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "order": {
- "id": 0,
- "customer_id": 0,
- "order_batch_id": 0,
- "quote_id": 0,
- "warehouse_id": 0,
- "return_warehouse_id": 0,
- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "status": 0,
- "status_name": "string",
- "previous_status": 0,
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "workable_at": "2019-08-24T14:15:22Z",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "address_verified": true,
- "items_updateable": true,
- "skip_address_verification": true,
- "address_message": "string",
- "shop_warehouse_ids": 0,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "billed": true,
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "incoterm": "EXW",
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_actual_cost": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_notes": "string",
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "ship_method": "string",
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": "string",
- "tracking_links": "string",
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_address_verified": true,
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "order_items": {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}, - "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "proto_originator_id": "string",
- "packages": [
- {
- "id": 0,
- "order_id": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_actual_cost": 0,
- "actual_weight": 0,
- "actual_width": 0,
- "actual_height": 0,
- "actual_length": 0,
- "actual_dimensional_weight": 0,
- "tracking": "string",
- "tracking_link": "string",
- "order_item_ids": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ucc128": "string",
- "ship_actual_currency": "string",
- "vics_bill_of_lading": "string",
- "manifest_id": 0,
- "batch_id": 0,
- "shipping_label_url": "string",
- "shipment_id": "string",
- "scan_form_url": "string",
- "shipment_created_at": "2019-08-24T14:15:22Z",
- "shipment_updated_at": "2019-08-24T14:15:22Z",
- "contents_label_printed_at": "2019-08-24T14:15:22Z",
- "shipping_label_printed_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "serial_numbers": [
- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "customer": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "workday_uuid": "string"
}, - "warehouse": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string",
- "fulfillment_cost_center": "string",
- "parcel_cost_center": "string"
}
}
X-Customer-Id | string The customer associated with this resource. |
consumer_return_id | integer <int32> ConsumerReturn id |
{- "consumer_return_id": 0
}
{- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "tracking": "string",
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "reference": "string",
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "return_items": {
- "id": 0,
- "item_id": 0,
- "name": "string",
- "sku": "string",
- "price": "string",
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "return_action": "string",
- "order_item_id": 0,
- "return_item_originator_id": 0,
- "originator_id": 0,
- "lot_ids": 0
}, - "exchange_order": {
- "id": 0,
- "customer_id": 0,
- "order_batch_id": 0,
- "quote_id": 0,
- "warehouse_id": 0,
- "return_warehouse_id": 0,
- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "status": 0,
- "status_name": "string",
- "previous_status": 0,
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "workable_at": "2019-08-24T14:15:22Z",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "address_verified": true,
- "items_updateable": true,
- "skip_address_verification": true,
- "address_message": "string",
- "shop_warehouse_ids": 0,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "billed": true,
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "incoterm": "EXW",
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_actual_cost": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_notes": "string",
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "ship_method": "string",
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": "string",
- "tracking_links": "string",
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_address_verified": true,
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "order_items": {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}, - "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "proto_originator_id": "string",
- "packages": [
- {
- "id": 0,
- "order_id": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_actual_cost": 0,
- "actual_weight": 0,
- "actual_width": 0,
- "actual_height": 0,
- "actual_length": 0,
- "actual_dimensional_weight": 0,
- "tracking": "string",
- "tracking_link": "string",
- "order_item_ids": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ucc128": "string",
- "ship_actual_currency": "string",
- "vics_bill_of_lading": "string",
- "manifest_id": 0,
- "batch_id": 0,
- "shipping_label_url": "string",
- "shipment_id": "string",
- "scan_form_url": "string",
- "shipment_created_at": "2019-08-24T14:15:22Z",
- "shipment_updated_at": "2019-08-24T14:15:22Z",
- "contents_label_printed_at": "2019-08-24T14:15:22Z",
- "shipping_label_printed_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "serial_numbers": [
- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "order": {
- "id": 0,
- "customer_id": 0,
- "order_batch_id": 0,
- "quote_id": 0,
- "warehouse_id": 0,
- "return_warehouse_id": 0,
- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "status": 0,
- "status_name": "string",
- "previous_status": 0,
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "workable_at": "2019-08-24T14:15:22Z",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "address_verified": true,
- "items_updateable": true,
- "skip_address_verification": true,
- "address_message": "string",
- "shop_warehouse_ids": 0,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "billed": true,
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "incoterm": "EXW",
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_actual_cost": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_notes": "string",
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "ship_method": "string",
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": "string",
- "tracking_links": "string",
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_address_verified": true,
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "order_items": {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}, - "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "proto_originator_id": "string",
- "packages": [
- {
- "id": 0,
- "order_id": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_actual_cost": 0,
- "actual_weight": 0,
- "actual_width": 0,
- "actual_height": 0,
- "actual_length": 0,
- "actual_dimensional_weight": 0,
- "tracking": "string",
- "tracking_link": "string",
- "order_item_ids": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ucc128": "string",
- "ship_actual_currency": "string",
- "vics_bill_of_lading": "string",
- "manifest_id": 0,
- "batch_id": 0,
- "shipping_label_url": "string",
- "shipment_id": "string",
- "scan_form_url": "string",
- "shipment_created_at": "2019-08-24T14:15:22Z",
- "shipment_updated_at": "2019-08-24T14:15:22Z",
- "contents_label_printed_at": "2019-08-24T14:15:22Z",
- "shipping_label_printed_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "serial_numbers": [
- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}, - "customer": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "workday_uuid": "string"
}, - "warehouse": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string",
- "fulfillment_cost_center": "string",
- "parcel_cost_center": "string"
}
}
Customer users don't have access to staff actions, so this simulates a ship notice's workflow, allowing you to process a ship notice and, optionally, finalize it.
shipnotice_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
finalize | boolean Default: true Finalize this Shipnotice |
randomize_receiving | boolean Randomize quantity to receive on this Shipnotice |
{- "finalize": true,
- "randomize_receiving": true
}
{- "id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "order_id": 0,
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "customer": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}, - "warehouse": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "purchase_order_numbers": [
- null
], - "inspection_required": true,
- "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "shipnotice_items": [
- {
- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
]
}
X-Customer-Id | string The customer associated with this resource. |
shipnotice_id | integer <int32> Shipnotice id |
{- "shipnotice_id": 0
}
{- "id": 0,
- "customer_id": 0,
- "warehouse_id": 0,
- "sender": "string",
- "eta": "2019-08-24T14:15:22Z",
- "status": 0,
- "status_name": "string",
- "received_by": "string",
- "notes_by_whiplash": "string",
- "notes_by_customer": "string",
- "total_boxes": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "arrived_at": "2019-08-24T14:15:22Z",
- "skip_images": true,
- "easypostable_id": "string",
- "easypostable_type": "string",
- "shipping_label_url": "string",
- "ship_actual_cost": 0,
- "shipping_method_text": "string",
- "carrier": "string",
- "shipping_method_id": 0,
- "tracking": "string",
- "order_id": 0,
- "type": "string",
- "postage_billed": true,
- "handling_billed": true,
- "ship_3rdparty_cost": 0,
- "requires_label": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "complete_by": "2019-08-24T14:15:22Z",
- "ship_actual_currency": "string",
- "delivered_at": "2019-08-24T14:15:22Z",
- "due_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "reference": "string",
- "shipnotice_item_count": 0,
- "shipnotice_item_sku_count": 0,
- "shipnotice_item_quantity": 0,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "customer": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "active": true,
- "auto_merge_gestation": 0,
- "default_warehouse_id": 0,
- "eori_number": "string",
- "estimated_monthly_volume": "string",
- "fedex_account": "string",
- "from_email": "string",
- "instructions": "string",
- "item_scanning_preference": true,
- "label_format": "string",
- "notes": "string",
- "notify_originator": true,
- "notify_originator_inventory": 0,
- "originator_permissions": true,
- "packing_slip_msg": "string",
- "packingslip_template": "string",
- "request_serial_numbers": true,
- "ship_method_preference": 0,
- "shipping_name": "string",
- "ups_account": "string",
- "vat_number": "string",
- "ein": "string",
- "warehouse_fallback": 0,
- "payment_hold": true,
- "exit_notice": true,
- "whitelisted_warehouses": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "allowed_warehouse_ids": 0,
- "account_level": 0,
- "account_level_name": "string",
- "activated_at": "2019-08-24T14:15:22Z",
- "deactivated_at": "2019-08-24T14:15:22Z",
- "auto_merge_skus": true,
- "partner_id": 0,
- "billing_email": "string",
- "billing_contact_name": "string",
- "billing_company": "string",
- "billing_phone1": "string",
- "billing_phone2": "string",
- "billing_address1": "string",
- "billing_address2": "string",
- "billing_address3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_residential": true,
- "items_returnable": true,
- "allow_international_returns": true,
- "items_exchangeable": true,
- "return_time_limit": 0,
- "return_label_expires_in": 0,
- "return_price_restricted": true,
- "return_sku_match": "string",
- "rma_display_logo": true,
- "rma_footer_content": "string",
- "return_name": "string",
- "return_company": "string",
- "return_email": "string",
- "return_phone": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_zip": "string",
- "return_country": "string",
- "supports_return_labels": true,
- "logo_content_type": "string",
- "logo_file_name": "string",
- "logo_file_size": 0,
- "logo_updated_at": "2019-08-24T14:15:22Z",
- "full_logo_url": "string",
- "email_confirmation_from": "string",
- "email_confirmation_name": "string",
- "email_confirmation_msg": "string",
- "email_confirmation_preference": 0,
- "email_confirmation_template": "string",
- "low_inventory_threshold": 0,
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "items_unavailable_on_sellout": 0,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "location_default_return_role": "string",
- "location_enable_pending_returns": true
}, - "warehouse": {
- "id": 0,
- "name": "string",
- "timezone": "string",
- "timezone_raw": "string",
- "partner_id": 0,
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "latitude": 0,
- "longitude": 0,
- "slug": "string",
- "default_pick_strategy": "string",
- "bin_total_count_max": 0,
- "bin_cubic_volume_max": 0,
- "number_of_groups": 0,
- "fedex_pickup_time": "string",
- "active": true,
- "square_footage": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ups_shipper_number": "string",
- "email": "string",
- "ups_carrier_facility": "string",
- "currency": "string",
- "vat": 0,
- "domestic_return_labels": true,
- "international_return_labels": true,
- "accepting_new_customers": true,
- "receiving_hours": "string",
- "pickup_hours": "string",
- "contact_name": "string",
- "contact_phone": "string",
- "delivery_appointment_required": true,
- "label_format": "string",
- "shipping_label_format": "string",
- "loading_dock_quantity": 0,
- "receiving_special_instructions": "string",
- "single_item_batch_size": "string",
- "packaging_customer_id": 0,
- "notes": "string",
- "warehouse_features": "string"
}, - "purchase_order_numbers": [
- null
], - "inspection_required": true,
- "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "shipnotice_items": [
- {
- "id": 0,
- "shipnotice_id": 0,
- "item_id": 0,
- "quantity": 0,
- "quantity_good": 0,
- "quantity_damaged": 0,
- "description": "string",
- "extended_description": "string",
- "include_in_published": true,
- "return_action": "string",
- "purchase_order_number": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "item": {
- "id": 0,
- "sku": "string",
- "title": "string",
- "description": "string",
- "full_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_id": 0,
- "quantity": 0,
- "weight": 0,
- "available": true,
- "image_originator_url": "string",
- "vendor": "string",
- "scancode": "string",
- "price": 0,
- "media_mail": true,
- "packaging": true,
- "length": 0,
- "width": 0,
- "height": 0,
- "active": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "packaging_type": "WhiplashBag",
- "promo": true,
- "street_date": "2019-08-24T14:15:22Z",
- "category": "string",
- "include_inbound_in_published": true,
- "returnable": true,
- "return_sku_match": "string",
- "return_price_restricted": true,
- "request_serial_number": true,
- "currency": "string",
- "tariff_number": "string",
- "notify_originator_inventory": 0,
- "name": "string",
- "image_url": "string",
- "hazmat": true,
- "hazmat_type": "ormd",
- "misc": "string",
- "ean": "string",
- "lot_control": true,
- "expiration_period": 0,
- "ship_strategy": 0,
- "velocity": 0,
- "case_quantity": 0,
- "carton_quantity": 0,
- "origin_country": "AF",
- "alcohol": true,
- "shippable_container": true,
- "replenishment_min": 0,
- "replenishment_target": 0,
- "low_inventory_threshold": 0,
- "published_quantity": 0
}, - "lot": {
- "id": 0,
- "number": "string",
- "expires_on": "2019-08-24",
- "shipnotice_item_id": 0
}, - "warehouse_id": 0,
- "unallocated": 0,
- "location_role": "string"
}
]
}
Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
order_id required | integer <int32> |
X-Customer-Id | string The customer associated with this resource. |
status | string Enum: "batched" "packed" "shipped" The target status for this order |
{- "status": "batched"
}
{- "id": 0,
- "customer_id": 0,
- "order_batch_id": 0,
- "quote_id": 0,
- "warehouse_id": 0,
- "return_warehouse_id": 0,
- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "status": 0,
- "status_name": "string",
- "previous_status": 0,
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "workable_at": "2019-08-24T14:15:22Z",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "address_verified": true,
- "items_updateable": true,
- "skip_address_verification": true,
- "address_message": "string",
- "shop_warehouse_ids": 0,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "billed": true,
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "incoterm": "EXW",
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_actual_cost": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_notes": "string",
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "ship_method": "string",
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": "string",
- "tracking_links": "string",
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_address_verified": true,
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "order_items": {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}, - "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "proto_originator_id": "string",
- "packages": [
- {
- "id": 0,
- "order_id": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_actual_cost": 0,
- "actual_weight": 0,
- "actual_width": 0,
- "actual_height": 0,
- "actual_length": 0,
- "actual_dimensional_weight": 0,
- "tracking": "string",
- "tracking_link": "string",
- "order_item_ids": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ucc128": "string",
- "ship_actual_currency": "string",
- "vics_bill_of_lading": "string",
- "manifest_id": 0,
- "batch_id": 0,
- "shipping_label_url": "string",
- "shipment_id": "string",
- "scan_form_url": "string",
- "shipment_created_at": "2019-08-24T14:15:22Z",
- "shipment_updated_at": "2019-08-24T14:15:22Z",
- "contents_label_printed_at": "2019-08-24T14:15:22Z",
- "shipping_label_printed_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "serial_numbers": [
- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
X-Customer-Id | string The customer associated with this resource. |
order_id | integer <int32> Order id |
{- "order_id": 0
}
{- "id": 0,
- "customer_id": 0,
- "order_batch_id": 0,
- "quote_id": 0,
- "warehouse_id": 0,
- "return_warehouse_id": 0,
- "shipping_method_id": 0,
- "estimated_shipping_method_id": 0,
- "humanize_id": "string",
- "status": 0,
- "status_name": "string",
- "previous_status": 0,
- "order_orig": "string",
- "level1_token": "string",
- "level2_token": "string",
- "workable_at": "2019-08-24T14:15:22Z",
- "skip_street_date": true,
- "due_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "meta_data": "string",
- "customer_provided_label_carrier": "string",
- "purchase_order": "string",
- "order_type": "string",
- "email": "string",
- "address_verified": true,
- "items_updateable": true,
- "skip_address_verification": true,
- "address_message": "string",
- "shop_warehouse_ids": 0,
- "shop_shipping_method_currency": "string",
- "shop_created_at": "2019-08-24T14:15:22Z",
- "shop_updated_at": "2019-08-24T14:15:22Z",
- "shop_shipping_method_text": "string",
- "shop_shipping_method_price": 0,
- "billing_company": "string",
- "billing_address_1": "string",
- "billing_address_2": "string",
- "billing_address_3": "string",
- "billing_city": "string",
- "billing_state": "string",
- "billing_zip": "string",
- "billing_country": "string",
- "billing_phone": "string",
- "billed": true,
- "do_not_bill": true,
- "billing_name": "string",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "shipping_name": "string",
- "shipping_company": "string",
- "shipping_address_1": "string",
- "shipping_address_2": "string",
- "shipping_city": "string",
- "shipping_state": "string",
- "shipping_zip": "string",
- "shipping_country": "string",
- "shipping_country_iso2": "string",
- "shipping_phone": "string",
- "requested_address": "string",
- "residential": true,
- "expedited": true,
- "require_signature": true,
- "require_adult_signature": true,
- "saturday_delivery": true,
- "gift": true,
- "insure": true,
- "contains_alcohol": true,
- "customs_required": true,
- "incoterm": "EXW",
- "shipping_carrier_facility": "string",
- "shipping_hold_for_pickup": true,
- "ship_actual_cost": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_notes": "string",
- "shipping_confirmation_sent": true,
- "ship_3rdparty_cost": 0,
- "ship_3rdparty_account": "string",
- "ship_3rdparty_zip": "string",
- "ship_3rdparty_country": "string",
- "public_note": "string",
- "days_in_transit": 0,
- "days_in_transit_carrier_estimate": 0,
- "req_insurance_value": 0,
- "ship_method": "string",
- "packingslip_pdf_url": "string",
- "cf_packingslip_pdf_url": "string",
- "customs_vat_number": "string",
- "customs_eori_number": "string",
- "customs_ioss_number": "string",
- "carrier_account_id": 0,
- "tracking": "string",
- "tracking_links": "string",
- "approximate_delivery_date": "2019-08-24",
- "global_e_ge_order": true,
- "calculated_time_limit": "string",
- "within_return_time_limit": true,
- "return_name": "string",
- "return_company": "string",
- "return_address_1": "string",
- "return_address_2": "string",
- "return_city": "string",
- "return_state": "string",
- "return_country": "string",
- "return_zip": "string",
- "return_phone": "string",
- "return_email": "string",
- "return_address_verified": true,
- "return_time_limit": 0,
- "is_workable": true,
- "is_gestating": true,
- "permissions_limited": true,
- "order_items": {
- "id": 0,
- "order_id": 0,
- "customer_id": 0,
- "item_id": 0,
- "package_id": 0,
- "quote_item_id": 0,
- "sku": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "unshippable": true,
- "available": true,
- "packed": 0,
- "packaging": true,
- "wholesale_cost": 0,
- "is_bundle": true,
- "retail_fee": 0,
- "promo": true,
- "returnable": true,
- "currency": "string",
- "wholesale_fee": 0,
- "hazmat": true,
- "misc": "string",
- "request_serial_number": true,
- "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}
}, - "originator": {
- "id": 0,
- "originated_id": 0,
- "originated_type": "string",
- "shop_id": 0,
- "provider": "string",
- "original_id": "string",
- "group_id": "string",
- "misc": "string",
- "active": true,
- "integration_id": 0,
- "last_notified_at": "2019-08-24T14:15:22Z",
- "last_notification_status": "string",
- "distinct_originator_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "application_id": 0
}, - "proto_originator_id": "string",
- "packages": [
- {
- "id": 0,
- "order_id": 0,
- "shipped_on": "2019-08-24T14:15:22Z",
- "ship_actual_cost": 0,
- "actual_weight": 0,
- "actual_width": 0,
- "actual_height": 0,
- "actual_length": 0,
- "actual_dimensional_weight": 0,
- "tracking": "string",
- "tracking_link": "string",
- "order_item_ids": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "ucc128": "string",
- "ship_actual_currency": "string",
- "vics_bill_of_lading": "string",
- "manifest_id": 0,
- "batch_id": 0,
- "shipping_label_url": "string",
- "shipment_id": "string",
- "scan_form_url": "string",
- "shipment_created_at": "2019-08-24T14:15:22Z",
- "shipment_updated_at": "2019-08-24T14:15:22Z",
- "contents_label_printed_at": "2019-08-24T14:15:22Z",
- "shipping_label_printed_at": "2019-08-24T14:15:22Z"
}
], - "shipping_method": {
- "id": 0,
- "carrier": "string",
- "service": "string",
- "description": "string",
- "name": "string",
- "international": true,
- "active": true,
- "flat_rate": true,
- "expedited": true,
- "trackable": true,
- "origins": "string",
- "extended_description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "serial_numbers": [
- {
- "id": 0,
- "order_item_id": 0,
- "shipnotice_item_id": 0,
- "text": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}