logo
API docs by Redocly

API (2)

Download OpenAPI specification:Download

Whiplash Development Team: tech@whiplash.com URL: https://www.getwhiplash.com

The Whiplash V2 API is open by invite only. Fill out request form here.
V2 documentation
V2.1 documentation

carrier_aliases

Operations about carrier_aliases

List all carrier_aliases

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

order_totes

Operations about order_totes

Count orders for a tote

path Parameters
code
required
string
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Count order items for an order tote

path Parameters
code
required
string
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

projects

Operations about projects

List all project_tasks

Get a list of project_tasks

path Parameters
id
required
integer <int32>
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

wholesale_items

Operations about wholesale_items

List all wholesale item objects

Returns all wholesale item objects

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a Wholesale item object

get a Wholesale item object

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_item_id": 0,
  • "line_no": "string",
  • "item_alias": "string",
  • "item_color": "string",
  • "item_size": "string",
  • "vendor_part_number": "string",
  • "buyer_part_number": "string",
  • "consumer_package_code": "string",
  • "outer_pack_value": "string",
  • "inner_pack_value": "string",
  • "size_description": "string",
  • "color_description": "string",
  • "upc": "string",
  • "description": "string",
  • "style": "string",
  • "ean": "string",
  • "alternate_item_number": "string",
  • "alternate_barcode": "string",
  • "alternate_sku": "string",
  • "lot": "string",
  • "ih_category": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a wholesale item object

path Parameters
id
required
integer <int32>
Request Body schema: application/json
order_item_id
integer <int32>

the associated order item id

line_no
string

the line number

item_alias
string

the item alias

item_color
string

the item color

item_size
string

the item size

vendor_part_number
string

the vendor part number

buyer_part_number
string

the buyer part number

consumer_package_code
string

the consumer package code

outer_pack_value
string

the outer pack value

inner_pack_value
string

the inner pack value

size_description
string

the size description

color_description
string

the color description

upc
string

the UPC

description
string

the description

style
string

the style

ean
string

the EAN

alternate_item_number
string

the alternate item number

alternate_barcode
string

the alternate barcode

alternate_sku
string

the alternate SKU

lot
string

the lot

ih_category
string

the IH category

Responses

Request samples

Content type
application/json
{
  • "order_item_id": 0,
  • "line_no": "string",
  • "item_alias": "string",
  • "item_color": "string",
  • "item_size": "string",
  • "vendor_part_number": "string",
  • "buyer_part_number": "string",
  • "consumer_package_code": "string",
  • "outer_pack_value": "string",
  • "inner_pack_value": "string",
  • "size_description": "string",
  • "color_description": "string",
  • "upc": "string",
  • "description": "string",
  • "style": "string",
  • "ean": "string",
  • "alternate_item_number": "string",
  • "alternate_barcode": "string",
  • "alternate_sku": "string",
  • "lot": "string",
  • "ih_category": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_item_id": 0,
  • "line_no": "string",
  • "item_alias": "string",
  • "item_color": "string",
  • "item_size": "string",
  • "vendor_part_number": "string",
  • "buyer_part_number": "string",
  • "consumer_package_code": "string",
  • "outer_pack_value": "string",
  • "inner_pack_value": "string",
  • "size_description": "string",
  • "color_description": "string",
  • "upc": "string",
  • "description": "string",
  • "style": "string",
  • "ean": "string",
  • "alternate_item_number": "string",
  • "alternate_barcode": "string",
  • "alternate_sku": "string",
  • "lot": "string",
  • "ih_category": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a wholesale item object

Delete a wholesale item object

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

items

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.

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List associated originators

Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.

path Parameters
id
required
integer <int32>
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "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
}

Add an item to an bundle

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.

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
quantity
required
integer <int32>

the bundle item quantity

item_id
required
integer <int32>

the bundle item item id

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "item_id": 0
}

Response samples

Content type
application/json
{
  • "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",
  • "item_quantity": "string",
  • "item_name": "string"
}

List all bundle items containing this item

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all items

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
[
  • {
    }
]

Create an item

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
sku
string

the item SKU number

title
string

the item title

description
string

the 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?

nmfc_code
string

the item National Motor Freight Classification code,

nmfc_class
string

the item National Motor Freight Classification class code

commodity_description
string

the item commodity description

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" "XK" "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?

goh
boolean

Garment on hanger?

label_format
string
Enum: "default" "whiplash_mini"

label format

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)

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "title": "string",
  • "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,
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "originators_attributes": [
    ],
  • "meta_fields": {
    }
}

Response samples

Content type
{
  • "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",
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "published_quantity": 0
}

Count items

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve an item

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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",
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "published_quantity": 0
}

Update an item

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
sku
string

the item SKU number

title
string

the item title

description
string

the 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?

nmfc_code
string

the item National Motor Freight Classification code,

nmfc_class
string

the item National Motor Freight Classification class code

commodity_description
string

the item commodity description

hazmat
boolean

(deprecated) is the item hazmat?

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" "XK" "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?

goh
boolean

Garment on hanger?

label_format
string
Enum: "default" "whiplash_mini"

label format

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

hazmat_type
string
Enum: "ormd" "lithium" "ORMD" "LITHIUM"

hazmat class

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "title": "string",
  • "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,
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "string",
  • "hazmat": true,
  • "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "hazmat_type": "ormd"
}

Response samples

Content type
{
  • "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",
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "published_quantity": 0
}

Archive an item

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.

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List all instances of this item in bundles

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
[
  • {
    }
]

Item stock by warehouse

Retrieve the quantity of this item in each warehouse in which it has stock

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "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
}

List all scancodes associated with this item

An item may have many alternate scancodes

path Parameters
id
required
integer <int32>
query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List locations associated with this item - by role

path Parameters
id
required
integer <int32>
query Parameters
role
string
Default: "pickable"
Enum: "pickable" "backstock" "damaged" "expired" "reserved" "pending" "external" "dropoff" "b_stock"

Pickable, backstock, etc

page
integer <int32>
Default: 1

Page number for pagination

per_page
integer <int32>
Default: 25

Number of locations per page for pagination

name
string

the location name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Perform an action on an item

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

path Parameters
id
required
integer <int32>
action
required
string
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
args
object

Method params

Responses

Request samples

Content type
application/json
{
  • "args": { }
}

Response samples

Content type
{
  • "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",
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "published_quantity": 0
}

List meta fields

Get the meta fields for a(n) Item

path Parameters
id
required
integer <int32>
query Parameters
associations[]
Array of strings

Include meta fields for associations

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Set meta fields

Update Item meta fields

path Parameters
id
required
integer <int32>
Request Body schema: application/json
fields
object

Hash of key/value pairs

association_fields
object

Included meta fields for associations

Responses

Request samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

List associated ship notice items

path Parameters
id
required
integer <int32>
query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count associated ship notice items

path Parameters
id
required
integer <int32>
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

List an item's history

Get all transactions for an item

path Parameters
id
required
integer <int32>
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count the transactions in an item's history

Returns count of item transactions

path Parameters
id
required
integer <int32>
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Export an item's transaction history

Triggers an asynchronous job to generate a CSV export

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "result": "string"
}

Retrieve a bundle item

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "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",
  • "item_quantity": "string",
  • "item_name": "string"
}

Update a bundle item's quantity

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
quantity
integer <int32>

the bundle item quantity

Responses

Request samples

Content type
application/json
{
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "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",
  • "item_quantity": "string",
  • "item_name": "string"
}

Destroy a bundle item

This removes the item from the bundle, but does not affect the item in any other way.

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

orders

Orders are end consumer requests for Items. An Order is comprised of OrderItems.

Orders represent outgoing stock.

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Create orders in bulk

Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created orders.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
Array of objects

An array of order objects to create in bulk

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the CustomsInfo object for an order

get the CustomsInfo object for an order

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_id": 0,
  • "customer_id": 0,
  • "importer_of_record_id": 0,
  • "send_electonic_trade_docs": true,
  • "signer": "string",
  • "au_vat_number": "string",
  • "eu_vat_number": "string",
  • "misc_vat_number": "string",
  • "uk_vat_number": "string",
  • "ioss_number": "string",
  • "eori_number": "string",
  • "receiver_tax_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List meta fields

Get the meta fields for a(n) Order

path Parameters
id
required
integer <int32>
query Parameters
associations[]
Array of strings

Include meta fields for associations

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Set meta fields

Update Order meta fields

path Parameters
id
required
integer <int32>
Request Body schema: application/json
fields
object

Hash of key/value pairs

association_fields
object

Included meta fields for associations

Responses

Request samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

List all order documents for an order

Retrieve all order documents for an order

path Parameters
id
required
integer <int32>
query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an order document for an order

OrderDocuments are files attached to and order, like a pre-printed shipping label, BOL, etc.

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
url
required
string

the order document file url

customer_id
integer <int32>

the order document customer id

document_type
string

the order document type

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "customer_id": 0,
  • "document_type": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_id": 0,
  • "customer_id": 0,
  • "url": "string",
  • "document_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List all order items for an order

Retrieve all order items for an order

path Parameters
id
required
integer <int32>
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an order item

Create an order item

path Parameters
id
required
integer <int32>
Request Body schema: application/json
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?

case_quantity
integer <int32>

How many of this item to a case?

carton_quantity
integer <int32>

How many CASES to a carton?

goh
boolean

Garment on hanger?

object
object

Hash of key value pairs (must conform to available meta keys)

object

Responses

Request samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "originator_attributes": {
    },
  • "meta_fields": {
    },
  • "wholesale_item_attributes": {
    }
}

Response samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "originator": {
    },
  • "wholesale_item": {
    }
}

Count order items

path Parameters
id
required
integer <int32>
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

List all orders

Retrieves a list of orders

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
[
  • {
    }
]

Create an order

Create an order

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

order_orig
string

the order original id (from the shop that sent whiplash the order)
Note: contains the global-e order id for any global-e order.

package_label_reference
string

User-defined reference for shipping labels on packages. Note: this field has a limit of 35 chars.

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" "value_added_service" "wholesale"

the order type

batch_priority
boolean

the order batch priority

email
string

the order shipping email

skip_address_verification
boolean

skip order shipping address verification? (staff only)

scac
string

the order scac number

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
ge_standard = order uses global-e standard shipping method
ge_express = order uses global-e express shipping method

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?

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?

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

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

customs_receiver_tax_id
string

RFC Tax id

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?

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

order_items
string
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: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 140 (Pending Pick Confirmation), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)

Array of objects

Order items attributes

object
object

Hash of key value pairs (must conform to available meta keys)

string
object

Responses

Request samples

Content type
application/json
{
  • "shipping_method_id": 0,
  • "estimated_shipping_method_id": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "skip_address_verification": true,
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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,
  • "require_signature": true,
  • "require_adult_signature": true,
  • "saturday_delivery": true,
  • "gift": true,
  • "insure": true,
  • "contains_alcohol": 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,
  • "customs_vat_number": "string",
  • "customs_eori_number": "string",
  • "customs_ioss_number": "string",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "approximate_delivery_date": "2019-08-24",
  • "global_e_ge_order": 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,
  • "order_items": "string",
  • "incoterm": "EXW",
  • "status": 30,
  • "order_items_attributes": [
    ],
  • "originator_attributes": {
    },
  • "meta_fields": {
    },
  • "": "string",
  • "wholesale_attributes": {
    }
}

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Count orders

Returns count of orders

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve an order

Retrieve an order

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Update an order

Update an order

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

order_orig
string

the order original id (from the shop that sent whiplash the order)
Note: contains the global-e order id for any global-e order.

package_label_reference
string

User-defined reference for shipping labels on packages. Note: this field has a limit of 35 chars.

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

batch_priority
boolean

the order batch priority

email
string

the order shipping email

skip_address_verification
boolean

skip order shipping address verification? (staff only)

scac
string

the order scac number

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
ge_standard = order uses global-e standard shipping method
ge_express = order uses global-e express shipping method

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?

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?

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

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

customs_receiver_tax_id
string

RFC Tax id

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?

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

object

Responses

Request samples

Content type
application/json
{
  • "shipping_method_id": 0,
  • "estimated_shipping_method_id": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "skip_address_verification": true,
  • "scac": "string",
  • "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,
  • "require_signature": true,
  • "require_adult_signature": true,
  • "saturday_delivery": true,
  • "gift": true,
  • "insure": true,
  • "contains_alcohol": 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",
  • "customs_vat_number": "string",
  • "customs_eori_number": "string",
  • "customs_ioss_number": "string",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "approximate_delivery_date": "2019-08-24",
  • "global_e_ge_order": 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",
  • "wholesale_attributes": {
    }
}

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Retrieve the history for an order

Get the order history

path Parameters
id
required
integer <int32>
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: 25

Number of results to return per page.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count order's events

Returns count of order's events

path Parameters
id
required
integer <int32>
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Perform an action on an order

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

path Parameters
id
required
integer <int32>
action
required
string
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
args
object

Method params

Responses

Request samples

Content type
application/json
{
  • "args": { }
}

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

List all serial numbers associated with an order item

Serial numbers are scanned and saved during the packing process.

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the Wholesale object for an order

get the Wholesale object for an order

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_id": 0,
  • "carrier_code": "string",
  • "carrier_service": "string",
  • "department": "string",
  • "department_description": "string",
  • "distribution_center": "string",
  • "fob_code": "string",
  • "gift_note": "string",
  • "location": "string",
  • "merchandise_type_code": "string",
  • "partner": "string",
  • "po_number": "string",
  • "sender": "string",
  • "vendor": "string",
  • "vendor_number": "string",
  • "store": "string",
  • "replenishment": "string",
  • "division": "string",
  • "fob_location_qualifier": "string",
  • "fob_location_description": "string",
  • "customer_account_number": "string",
  • "sort_code": "string",
  • "group": "string",
  • "seller_name": "string",
  • "reference": "string",
  • "start_date": "2019-08-24",
  • "cancel_date": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete an order document

Remove an order document from an order

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

order_items

An OrderItem represent an Item with a quantity in an Order.

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List meta fields

Get the meta fields for a(n) OrderItem

path Parameters
id
required
integer <int32>
query Parameters
associations[]
Array of strings

Include meta fields for associations

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Set meta fields

Update OrderItem meta fields

path Parameters
id
required
integer <int32>
Request Body schema: application/json
fields
object

Hash of key/value pairs

association_fields
object

Included meta fields for associations

Responses

Request samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Retrieve an order item

Retrieve an order item

path Parameters
id
required
integer <int32>
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: 25

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "originator": {
    },
  • "wholesale_item": {
    }
}

Update an order item

Update an order item

path Parameters
id
required
integer <int32>
Request Body schema: application/json
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?

case_quantity
integer <int32>

How many of this item to a case?

carton_quantity
integer <int32>

How many CASES to a carton?

goh
boolean

Garment on hanger?

object

Responses

Request samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "wholesale_item_attributes": {
    }
}

Response samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "originator": {
    },
  • "wholesale_item": {
    }
}

Destroy an order item

Destroy an order item

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Separate an order item

Separate an order item into a new order

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "originator": {
    },
  • "wholesale_item": {
    }
}

Perform an action on an order_item

Perform an action on an order_item

path Parameters
id
required
integer <int32>
action
required
string
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
args
object

Method params

Responses

Request samples

Content type
application/json
{
  • "args": { }
}

Response samples

Content type
application/json
{
  • "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,
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "originator": {
    },
  • "wholesale_item": {
    }
}

List all serial numbers associated with an order item

Serial numbers are scanned and saved during the packing process.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the Wholesale item object for an order item

get the Wholesale item object for an order item

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_item_id": 0,
  • "line_no": "string",
  • "item_alias": "string",
  • "item_color": "string",
  • "item_size": "string",
  • "vendor_part_number": "string",
  • "buyer_part_number": "string",
  • "consumer_package_code": "string",
  • "outer_pack_value": "string",
  • "inner_pack_value": "string",
  • "size_description": "string",
  • "color_description": "string",
  • "upc": "string",
  • "description": "string",
  • "style": "string",
  • "ean": "string",
  • "alternate_item_number": "string",
  • "alternate_barcode": "string",
  • "alternate_sku": "string",
  • "lot": "string",
  • "ih_category": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a wholesale item object

path Parameters
id
required
integer <int32>
Request Body schema: application/json
order_item_id
integer <int32>

the associated order item id

line_no
string

the line number

item_alias
string

the item alias

item_color
string

the item color

item_size
string

the item size

vendor_part_number
string

the vendor part number

buyer_part_number
string

the buyer part number

consumer_package_code
string

the consumer package code

outer_pack_value
string

the outer pack value

inner_pack_value
string

the inner pack value

size_description
string

the size description

color_description
string

the color description

upc
string

the UPC

description
string

the description

style
string

the style

ean
string

the EAN

alternate_item_number
string

the alternate item number

alternate_barcode
string

the alternate barcode

alternate_sku
string

the alternate SKU

lot
string

the lot

ih_category
string

the IH category

Responses

Request samples

Content type
application/json
{
  • "order_item_id": 0,
  • "line_no": "string",
  • "item_alias": "string",
  • "item_color": "string",
  • "item_size": "string",
  • "vendor_part_number": "string",
  • "buyer_part_number": "string",
  • "consumer_package_code": "string",
  • "outer_pack_value": "string",
  • "inner_pack_value": "string",
  • "size_description": "string",
  • "color_description": "string",
  • "upc": "string",
  • "description": "string",
  • "style": "string",
  • "ean": "string",
  • "alternate_item_number": "string",
  • "alternate_barcode": "string",
  • "alternate_sku": "string",
  • "lot": "string",
  • "ih_category": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "order_item_id": 0,
  • "line_no": "string",
  • "item_alias": "string",
  • "item_color": "string",
  • "item_size": "string",
  • "vendor_part_number": "string",
  • "buyer_part_number": "string",
  • "consumer_package_code": "string",
  • "outer_pack_value": "string",
  • "inner_pack_value": "string",
  • "size_description": "string",
  • "color_description": "string",
  • "upc": "string",
  • "description": "string",
  • "style": "string",
  • "ean": "string",
  • "alternate_item_number": "string",
  • "alternate_barcode": "string",
  • "alternate_sku": "string",
  • "lot": "string",
  • "ih_category": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

shipnotices

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.

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Create shipnotices in bulk

Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created shipnotices.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
required
Array of objects

An array of shipnotice objects to create in bulk

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List meta fields

Get the meta fields for a(n) Shipnotice

path Parameters
id
required
integer <int32>
query Parameters
associations[]
Array of strings

Include meta fields for associations

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Set meta fields

Update Shipnotice meta fields

path Parameters
id
required
integer <int32>
Request Body schema: application/json
fields
object

Hash of key/value pairs

association_fields
object

Included meta fields for associations

Responses

Request samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Create a ship notice item

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
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)

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "lot_attributes": {
    },
  • "meta_fields": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "lot": {
    },
  • "item_image_url": "string",
  • "item_scancode": "string",
  • "item_sku": "string",
  • "item_title": "string",
  • "item_lot_control": true,
  • "item_currency": "string",
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "warehouse_id": 0,
  • "unallocated": 0,
  • "location_role": "string"
}

List associated ship notice items

path Parameters
id
required
integer <int32>
query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count associated ship notice items

path Parameters
id
required
integer <int32>
query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

List all ship notices

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
[
  • {
    }
]

Create a ship notice

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

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

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

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

quantities_verified
object

JSON object of required and optional receiving quantities verified by staff

inspection_required
boolean

is inspection required? (default: false)

processing_started_at
string <date-time>

when the shipnotice entered Processing status

Array of objects
object
object

Hash of key value pairs (must conform to available meta keys)

carrier
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "eta": "2019-08-24T14:15:22Z",
  • "warehouse_id": 0,
  • "status": 0,
  • "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",
  • "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",
  • "ship_actual_currency": "string",
  • "delivered_at": "2019-08-24T14:15:22Z",
  • "due_at": "2019-08-24T14:15:22Z",
  • "meta_data": "string",
  • "reference": "string",
  • "quantities_verified": { },
  • "inspection_required": true,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "shipnotice_items_attributes": [
    ],
  • "originator_attributes": {
    },
  • "meta_fields": {
    },
  • "carrier": "string"
}

Response samples

Content type
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Count ship notices

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve a ship notice

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Update a ship notice

NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
sender
string

the shipnotice sender

eta
string <date-time>

the shipnotice estimated arrival date

status
integer <int32>

status of the shipnotice

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

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

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

quantities_verified
object

JSON object of required and optional receiving quantities verified by staff

shipnotice_items
string
processing_started_at
string <date-time>

when the shipnotice entered Processing status

carrier
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "eta": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "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",
  • "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",
  • "ship_actual_currency": "string",
  • "delivered_at": "2019-08-24T14:15:22Z",
  • "due_at": "2019-08-24T14:15:22Z",
  • "meta_data": "string",
  • "reference": "string",
  • "quantities_verified": { },
  • "shipnotice_items": "string",
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "carrier": "string"
}

Response samples

Content type
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Destroy a ship notice

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Count orders waiting for stock in a ship notice

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

shipnotice_items

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.

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List meta fields

Get the meta fields for a(n) ShipnoticeItem

path Parameters
id
required
integer <int32>
query Parameters
associations[]
Array of strings

Include meta fields for associations

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Set meta fields

Update ShipnoticeItem meta fields

path Parameters
id
required
integer <int32>
Request Body schema: application/json
fields
object

Hash of key/value pairs

association_fields
object

Included meta fields for associations

Responses

Request samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Count ship notice items

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve a ship notice item

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "lot": {
    },
  • "item_image_url": "string",
  • "item_scancode": "string",
  • "item_sku": "string",
  • "item_title": "string",
  • "item_lot_control": true,
  • "item_currency": "string",
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "warehouse_id": 0,
  • "unallocated": 0,
  • "location_role": "string"
}

Update a ship notice item

path Parameters
id
required
integer <int32>
Request Body schema: application/json
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)

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "description": "string",
  • "extended_description": "string",
  • "include_in_published": true,
  • "purchase_order_number": "string",
  • "location_role": "string"
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "lot": {
    },
  • "item_image_url": "string",
  • "item_scancode": "string",
  • "item_sku": "string",
  • "item_title": "string",
  • "item_lot_control": true,
  • "item_currency": "string",
  • "case_quantity": 0,
  • "carton_quantity": 0,
  • "goh": true,
  • "warehouse_id": 0,
  • "unallocated": 0,
  • "location_role": "string"
}

Destroy a shipnotice item

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

consumer_returns

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.

Retrieve a consumer return

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}

Update a consumer return

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}

Destroy a consumer return

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List meta fields

Get the meta fields for a(n) ConsumerReturn

path Parameters
id
required
integer <int32>
query Parameters
associations[]
Array of strings

Include meta fields for associations

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Set meta fields

Update ConsumerReturn meta fields

path Parameters
id
required
integer <int32>
Request Body schema: application/json
fields
object

Hash of key/value pairs

association_fields
object

Included meta fields for associations

Responses

Request samples

Content type
application/json
{
  • "fields": { },
  • "association_fields": { }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Create consumer_returns in bulk

Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
required
Array of objects

An array of consumer_return objects to create in bulk

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List all consumer returns

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
[
  • {
    }
]

Create a consumer return

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
order_id
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

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

Responses

Request samples

Content type
application/json
{
  • "order_id": 0,
  • "customer_id": 0,
  • "warehouse_id": 0,
  • "sender": "string",
  • "eta": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "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": [
    ],
  • "originator_attributes": {
    },
  • "meta_fields": {
    },
  • "exchange_items": [
    ]
}

Response samples

Content type
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}

Count consumer returns

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

originators

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.

Retrieve an order

Retrieve an order

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Update an order

Update an order

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

order_orig
string

the order original id (from the shop that sent whiplash the order)
Note: contains the global-e order id for any global-e order.

package_label_reference
string

User-defined reference for shipping labels on packages. Note: this field has a limit of 35 chars.

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

batch_priority
boolean

the order batch priority

email
string

the order shipping email

skip_address_verification
boolean

skip order shipping address verification? (staff only)

scac
string

the order scac number

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
ge_standard = order uses global-e standard shipping method
ge_express = order uses global-e express shipping method

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?

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?

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

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

customs_receiver_tax_id
string

RFC Tax id

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?

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

object

Responses

Request samples

Content type
application/json
{
  • "shipping_method_id": 0,
  • "estimated_shipping_method_id": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "skip_address_verification": true,
  • "scac": "string",
  • "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,
  • "require_signature": true,
  • "require_adult_signature": true,
  • "saturday_delivery": true,
  • "gift": true,
  • "insure": true,
  • "contains_alcohol": 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",
  • "customs_vat_number": "string",
  • "customs_eori_number": "string",
  • "customs_ioss_number": "string",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "approximate_delivery_date": "2019-08-24",
  • "global_e_ge_order": 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",
  • "wholesale_attributes": {
    }
}

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Retrieve an item

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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",
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "published_quantity": 0
}

Update an item

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
sku
string

the item SKU number

title
string

the item title

description
string

the 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?

nmfc_code
string

the item National Motor Freight Classification code,

nmfc_class
string

the item National Motor Freight Classification class code

commodity_description
string

the item commodity description

hazmat
boolean

(deprecated) is the item hazmat?

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" "XK" "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?

goh
boolean

Garment on hanger?

label_format
string
Enum: "default" "whiplash_mini"

label format

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

hazmat_type
string
Enum: "ormd" "lithium" "ORMD" "LITHIUM"

hazmat class

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "title": "string",
  • "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,
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "string",
  • "hazmat": true,
  • "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "hazmat_type": "ormd"
}

Response samples

Content type
{
  • "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",
  • "nmfc_code": "string",
  • "nmfc_class": "string",
  • "commodity_description": "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,
  • "goh": true,
  • "label_format": "default",
  • "replenishment_min": 0,
  • "replenishment_target": 0,
  • "low_inventory_threshold": 0,
  • "published_quantity": 0
}

Archive an item

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.

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List all instances of this item in bundles

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
[
  • {
    }
]

List all bundle items containing this item

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Item stock by warehouse

Retrieve the quantity of this item in each warehouse in which it has stock

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "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
}

List all scancodes associated with this item

An item may have many alternate scancodes

path Parameters
originator_id
required
integer <int32>
query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List locations associated with this item - by role

path Parameters
originator_id
required
integer <int32>
query Parameters
role
string
Default: "pickable"
Enum: "pickable" "backstock" "damaged" "expired" "reserved" "pending" "external" "dropoff" "b_stock"

Pickable, backstock, etc

page
integer <int32>
Default: 1

Page number for pagination

per_page
integer <int32>
Default: 25

Number of locations per page for pagination

name
string

the location name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a ship notice

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Update a ship notice

NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
sender
string

the shipnotice sender

eta
string <date-time>

the shipnotice estimated arrival date

status
integer <int32>

status of the shipnotice

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

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

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

quantities_verified
object

JSON object of required and optional receiving quantities verified by staff

shipnotice_items
string
processing_started_at
string <date-time>

when the shipnotice entered Processing status

carrier
string

Responses

Request samples

Content type
application/json
{
  • "sender": "string",
  • "eta": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "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",
  • "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",
  • "ship_actual_currency": "string",
  • "delivered_at": "2019-08-24T14:15:22Z",
  • "due_at": "2019-08-24T14:15:22Z",
  • "meta_data": "string",
  • "reference": "string",
  • "quantities_verified": { },
  • "shipnotice_items": "string",
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "carrier": "string"
}

Response samples

Content type
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Destroy a ship notice

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Retrieve a consumer return

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}

Update a consumer return

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}

Destroy a consumer return

path Parameters
originator_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List originators

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

meta_keys

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

Customers are Whiplash clients, not the End Consumer. Most Whiplash resources are owned by a Customer (or belong to resources that are).

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List all customers

query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count customers

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve a customer

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "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",
  • "gs1_company_prefix": "string",
  • "warehouse_fallback": 0,
  • "payment_hold": true,
  • "primary_contact": "string",
  • "exit_notice": true,
  • "data_mapping_string": "string",
  • "whitelisted_warehouses": {
    },
  • "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,
  • "allow_b_stock_receiving": true,
  • "location_default_return_role": "string",
  • "location_enable_pending_returns": true,
  • "location_enable_receiving_into_reserved": true,
  • "receiving_fields": [
    ],
  • "project_task_labels": [
    ],
  • "dashboard_enable_domo": "string",
  • "dashboard_enable_parcel_insights": "string",
  • "billing_core": true
}

Update a customer

Update your customers' information and preferences

path Parameters
id
required
integer <int32>
Request Body schema: application/json
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

gs1_company_prefix
string

GS1 company prefix for barcodes

warehouse_fallback
integer <int32>

Customer warehouse fallback.

payment_hold
boolean

is this account on hold pending a valid payment method?

primary_contact
string

The Customers designated primary contact.

exit_notice
boolean

is this account flagged for exit notice? (admins only)

data_mapping_string
string

Data mapping string for this customer. (admins only)

account_level
integer <int32>

Account level

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. Whiplash will automatically turn on Process Orders when an item is received or adjusted in, and turn it off when an Item sells out.

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

allow_b_stock_receiving
boolean

Allow "b stock" role for receiving

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

location_enable_receiving_into_reserved
boolean

Allow "reserved" role for receiving items

dashboard_enable_domo
string

Enable Domo dashboard for this customer

dashboard_enable_parcel_insights
string

Enable Parcel Insights for this customer

billing_core
boolean

if false, disables hardcoded billing logic (staff only)

Responses

Request samples

Content type
application/json
{
  • "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",
  • "gs1_company_prefix": "string",
  • "warehouse_fallback": 0,
  • "payment_hold": true,
  • "primary_contact": "string",
  • "exit_notice": true,
  • "data_mapping_string": "string",
  • "account_level": 0,
  • "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,
  • "allow_b_stock_receiving": true,
  • "location_default_return_role": "string",
  • "location_enable_pending_returns": true,
  • "location_enable_receiving_into_reserved": true,
  • "dashboard_enable_domo": "string",
  • "dashboard_enable_parcel_insights": "string",
  • "billing_core": true
}

Response samples

Content type
application/json
{
  • "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",
  • "gs1_company_prefix": "string",
  • "warehouse_fallback": 0,
  • "payment_hold": true,
  • "primary_contact": "string",
  • "exit_notice": true,
  • "data_mapping_string": "string",
  • "whitelisted_warehouses": {
    },
  • "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,
  • "allow_b_stock_receiving": true,
  • "location_default_return_role": "string",
  • "location_enable_pending_returns": true,
  • "location_enable_receiving_into_reserved": true,
  • "receiving_fields": [
    ],
  • "project_task_labels": [
    ],
  • "dashboard_enable_domo": "string",
  • "dashboard_enable_parcel_insights": "string",
  • "billing_core": true
}

documents

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.

List actions you can perform

Get resource actions

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List all documents

query Parameters
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").

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a document

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
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

signed_url
string

the document pre-signed url

keyword_list
string

Comma separated list of keyword tags

message_list
string

Comma separated list of message tags

context_list
string

Comma separated list of context tags

resource_type_list
string

Comma separated list resource_type tags

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "partner_id": 0,
  • "owner_id": 0,
  • "owner_type": "string",
  • "customer_name": "string",
  • "partner_name": "string",
  • "user_name": "string",
  • "signed_url": "string",
  • "keyword_list": "string",
  • "message_list": "string",
  • "context_list": "string",
  • "resource_type_list": "string"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "message_list": [
    ],
  • "context_list": [
    ],
  • "resource_type_list": [
    ],
  • "customer_name": "string",
  • "partner_name": "string",
  • "user_name": "string",
  • "signed_url": "string"
}

Retrieve a document

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "message_list": [
    ],
  • "context_list": [
    ],
  • "resource_type_list": [
    ],
  • "customer_name": "string",
  • "partner_name": "string",
  • "user_name": "string",
  • "signed_url": "string"
}

Destroy an document

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

notifications

You can subscribe to E-mail, web hook, and Slack 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.

List all notification events

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.

query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a notification event

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "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"
}

List all notification subscriptions

E-mail, webhook, and Slack notifications you have subscribed to

query Parameters
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.

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a notification subscription

Subscribe to an e-mail, webhook, or Slack notification for a specified event

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "notification_type": "string",
  • "notification_event_id": 0,
  • "endpoint": "string",
  • "customer_id": 0,
  • "user_id": 0,
  • "active": true,
  • "version": 0
}

Response samples

Content type
application/json
{
  • "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": {
    }
}

Count notification subscriptions

Get a count of notification subscriptions

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve a notification subscription

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "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": {
    }
}

Update a notification subscription

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "notification_event_id": 0,
  • "customer_id": 0,
  • "user_id": 0,
  • "notification_type": "string",
  • "endpoint": "string",
  • "active": true,
  • "version": 0
}

Response samples

Content type
application/json
{
  • "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": {
    }
}

Delete a notification subscription

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Test a notification subscription

Send yourself a test e-mail, webhook, or Slack notification

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "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": {
    }
}

templates

Templates allow you to customize packing slips, email confirmations, order inserts, etc

Retrieve a template

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "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": {
    }
}

Update a template

path Parameters
id
required
integer <int32>
Request Body schema: application/json
name
string

Name of the template

content
string

Content of the template

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "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": {
    }
}

Destroy a template

path Parameters
id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Responses

Response samples

Content type
application/json
{
  • "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": {
    }
}

List all templates

query Parameters
search
string

JSON search string like {"attribute_eq": "Term"}

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: 25

Number of results to return per page.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a template

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "template_type_id": 0,
  • "content": "string",
  • "default": true
}

Response samples

Content type
application/json
{
  • "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": {
    }
}

simulate

(Sandbox Only) Simulate Order and Ship Notice processing, since these are staff-only operations.

Create an order with simulated data

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
order_id
integer <int32>

Order id

Responses

Request samples

Content type
application/json
{
  • "order_id": 0
}

Response samples

Content type
application/json
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Simulate processing for an order

Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped

path Parameters
order_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
status
string
Enum: "batched" "packed" "shipped"

The target status for this order

Responses

Request samples

Content type
application/json
{
  • "status": "batched"
}

Response samples

Content type
{
  • "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": 30,
  • "status_name": "string",
  • "previous_status": 0,
  • "order_orig": "string",
  • "package_label_reference": "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",
  • "batch_priority": true,
  • "email": "string",
  • "address_verified": true,
  • "items_updateable": true,
  • "skip_address_verification": true,
  • "address_message": "string",
  • "scac": "string",
  • "shop_warehouse_ids": [
    ],
  • "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",
  • "customs_receiver_tax_id": "string",
  • "carrier_account_id": 0,
  • "tracking": [
    ],
  • "tracking_links": [
    ],
  • "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": [
    ],
  • "originator": {
    },
  • "proto_originator_id": "string",
  • "packages": [
    ],
  • "shipping_method": {
    },
  • "serial_numbers": [
    ]
}

Create a shipnotice with simulated data

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
shipnotice_id
integer <int32>

Shipnotice id

Responses

Request samples

Content type
application/json
{
  • "shipnotice_id": 0
}

Response samples

Content type
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Simulate processing for an ship notice

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.

path Parameters
shipnotice_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
finalize
boolean
Default: true

Finalize this Shipnotice

randomize_receiving
boolean
Default: false

Randomize quantity to receive on this Shipnotice

Responses

Request samples

Content type
application/json
{
  • "finalize": true,
  • "randomize_receiving": false
}

Response samples

Content type
application/json
{
  • "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,
  • "purchase_order_numbers": [
    ],
  • "quantities_verified": { },
  • "originator": {
    },
  • "customer": {
    },
  • "warehouse": {
    },
  • "inspection_required": true,
  • "shipping_method": {
    },
  • "shipnotice_items": [
    ],
  • "processing_started_at": "2019-08-24T14:15:22Z"
}

Create a consumer return with simulated data

header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
consumer_return_id
integer <int32>

ConsumerReturn id

Responses

Request samples

Content type
application/json
{
  • "consumer_return_id": 0
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}

Simulate processing for an consumer return

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.

path Parameters
consumer_return_id
required
integer <int32>
header Parameters
X-Customer-Id
string

The customer associated with this resource.

Request Body schema: application/json
finalize
boolean
Default: true

Finalize this ConsumerReturn

Responses

Request samples

Content type
application/json
{
  • "finalize": true
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "return_items": [
    ],
  • "exchange_order": {
    },
  • "order": {
    },
  • "customer": {
    },
  • "warehouse": {
    }
}