List all Shipments

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Query Parameters

fields

enum<string>[]

Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

shipping_account,

shipping_method,

shipping_method_name,

target_ship_date,

total_weight,

shipped_weight,

items,

item_weight,

packages,

packing_solution,

picking_class_id,

is_cutoff_date_exception,

is_manually_processed,

label_print_target,

scac,

carrier_shipping_cost,

is_international,

is_documents_required,

is_electronic_customs,

infill_product_id,

max_package_weight,

packing_solution_providers,

tpb_group,

created_at,

updated_at,

packed_at

fields:items

enum<string>[]

Specify additional fields of the ShipmentItem object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

sku,

product,

quantity,

qty_shipped,

qty_picked,

qty_canceled,

qty_cancel_requested,

order_item,

reservations

fields:items.product

enum<string>[]

Specify additional fields of the Product objects to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:

basic,

all,

created_at,

updated_at,

container_options,

supplies_options,

data_collection_options,

instruction_options,

infill_options,

vendor_sku,

external_id,

barcodes,

goods_type,

is_available,

is_visible,

weight,

dimensions,

volume,

inventory,

export,

regulated_goods,

packaging,

custom_fields

fields:items.order_item

enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

Available options:

all,

order_item_ref,

qty_ordered,

qty_assigned,

qty_allocated,

qty_backordered,

qty_processing,

qty_picked,

qty_shipped,

qty_cancel_requested,

qty_canceled,

row_weight

fields:order

enum<string>[]

Specify additional fields of the Order object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

carrier_code,

shipping_method,

signature_required,

is_saturday_delivery,

is_overbox_required,

other_shipping_options,

priority,

requested_ship_date,

is_declared_value_service,

declared_value,

shipping_address,

items,

shipments,

created_at,

updated_at,

completed_at,

status_history,

custom_greeting

fields:order.items

enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

Available options:

all,

sku,

order_item_ref,

product,

qty_ordered,

qty_assigned,

qty_allocated,

qty_backordered,

qty_processing,

qty_picked,

qty_shipped,

qty_cancel_requested,

qty_canceled,

row_weight

fields:order.shipments

enum<string>[]

Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

shipping_account,

shipping_method,

shipping_method_name,

target_ship_date,

total_weight,

shipped_weight,

items,

item_weight,

packages,

packing_solution,

picking_class_id,

is_cutoff_date_exception,

is_manually_processed,

label_print_target,

scac,

carrier_shipping_cost,

is_international,

is_documents_required,

is_electronic_customs,

infill_product_id,

max_package_weight,

packing_solution_providers,

tpb_group,

created_at,

updated_at,

packed_at

fields:order.merchant

enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

code,

name,

status,

created_at,

updated_at,

brands,

default_brand

fields:order.brand

enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

code,

name,

is_active,

is_deleted,

sort_order

fields:order.shipping_address

enum<string>[]

Specify additional fields of the OrderAddress object to be included in the response. See the selecting fields page for more information.

Available options:

all,

first_name,,

last_name,,

company,,

street,,

city,,

region,,

postcode,,

country,,

telephone,,

email,,

classification,,

is_valid

fields:order.status_history

enum<string>[]

Specify additional fields of the OrderStatusHistory object to be included in the response. See the selecting fields page for more information.

Available options:

all,

status,

comment,

notify_merchant,

user,

script_id,

created_at

fields:warehouse

enum<string>[]

Specify additional fields of the Warehouse object to be included in the response.

Available options:

all

fields:packages

enum<string>[]

Specify additional fields of the ShipmentPackage object to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:

basic,

all,

created_at,

updated_at,

container_options,

supplies_options,

data_collection_options,

instruction_options,

infill_options,

vendor_sku,

external_id,

barcodes,

goods_type,

is_available,

is_visible,

weight,

dimensions,

volume,

inventory,

export,

regulated_goods,

packaging,

custom_fields

fields:packages.items

enum<string>[]

Specify additional fields of the ShipmentPackageItem object to be included in the response.

Available options:

all,

sku,

name,

quantity,

weight,

hazmat_unit_weight,

customs_value,

order_item_id,

order_item_sku,

order_item_quantity

fields:packing_solution

enum<string>[]

Specify additional fields of the ShipmentPackingSolution object to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:

all,

created_at,

updated_at

filter

string[]

Using the filtering syntax, you may filter the results using the following fields:

id
unique_id
created_at
updated_at
packed_at

sort

string

The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:

id
unique_id
created_at
updated_at
packed_at
merchant_id

count

integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1

cursor_end

integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

cursor_start

integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

limit

integer

default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000

Example:

100

Response

A dictionary with a collection property that contains an array of up to limit Shipment objects. If no shipments are found the array will be empty.

collection

Shipment · object[]

A list of Shipment objects.

Show child attributes

collection.type

enum<string>

Available options:

Shipment

collection.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

collection.unique_id

string

A unique ID for the shipment. This number may appear on the packing slip as the "Packing Slip #".

Example:

"1100000003"

collection.external_id

string

An arbitrary string to use as an external reference ID.

Maximum string length: 64

collection.status

enum<string>

The shipment status indicates which stage the shipment is in.

Available options:

new,

picking,

picked,

packing,

packed,

loaded,

canceled,

voided,

packing_exception,

shipped

Example:

"new"

collection.shipping_carrier_code

string

The ShipStream carrier code for the shipment. This will always be the same as the prefix for the shipping_service_code.

Example:

"fedex"

collection.shipping_method

string

The shipping method that is ultimately chosen for the shipment. Virtual Shipping Methods such as "Cheapest All" will determine the shipment's shipping method after rating data has been calculated.
Optional Field

collection.shipping_method_name

string

The name of the shipping method.
Optional Field

collection.shipping_service_code

string

The shipping service that is assigned to the shipment. This value is unique to ShipStream and the prefix is always equivalent to the shipping_carrier_code which is provided separately for convenience. This value is often the same as the Order's shipping_method_code but could be different if:

The order was updated after the shipment was packed
A Virtual Shipping Method was used to assign a shipping method based on rate shopping
A Preprocess Packing Solution Script was used to assign a specific shipping method

collection.shipping_service_name

string

The human-friendly name of the shipping service assigned to this shipment. This value is the same as the label returned by the shipping/shipping_method Enumeration.

Example:

"fedex_FEDEX_2_DAY"

collection.warehouse

WarehouseRef · object

A reference to a Warehouse by id.

Show child attributes

collection.warehouse.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

collection.warehouse.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

collection.order

OrderRef · object

A reference to an Order by id.

Show child attributes

collection.order.type

enum<string>

required

Available options:

Order

collection.order.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

collection.shipping_account

ShippingAccount · object

The shipping account used to submit this shipment.
Optional Field

Show child attributes

collection.shipping_account.type

enum<string>

required

Available options:

ShippingAccount

collection.shipping_account.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

collection.target_ship_date

string<date> | null

The date that the shipment is scheduled to be completed.
Optional Field

collection.item_weight

Weight · object

The total weight of all shipment items (does not include packaging).
Optional Field

Show child attributes

collection.item_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.item_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

collection.shipped_weight

Weight · object

The weight of all shipment items and packaging at the time of shipping.
Optional Field

Show child attributes

collection.shipped_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.shipped_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

collection.items

ShipmentItem · object[]

A list of items belonging to the Shipment.
Optional Field

Minimum array length: 1

Show child attributes

collection.items.type

enum<string>

required

Available options:

ShipmentItem

collection.items.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

collection.items.product

ProductRef · object

The Product this shipment line-item refers to.

Show child attributes

collection.items.product.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

collection.items.product.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

collection.packages

ShipmentPackage · object[]

The list of packages included in the shipment.
Optional Field

Show child attributes

collection.packages.items

object[]

A list of items contained within the ShipmentPackage.

Minimum array length: 1

Show child attributes

collection.packages.items.sku

string

The SKU identifier for the product contained in the package.

Example:

"KDS2108"

collection.packages.items.quantity

integer

The quantity of a particular product in a package.

Example:

2

collection.packages.items.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

collection.packages.items.order_item_sku

string

The SKU identifier for the product as it relates to the shipment in an order.

Example:

"KDS2108"

collection.packages.items.order_item_qty

number<float>

The quantity of a product in the shipment of an order.

Example:

2

collection.packages.items.shipment_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

collection.packages.items.weight

Weight · object

The combined weight of the the same items in the package.

Show child attributes

collection.packages.items.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.packages.items.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

collection.packages.items.hazmat_unit_weight

Weight · object

The combined weight of the same items in thie package formatted for hazmat inspection.

Show child attributes

collection.packages.items.hazmat_unit_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.packages.items.hazmat_unit_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

collection.packages.items.total_customs_value

Monetary · object

The combined value of the same items in the package.

Show child attributes

collection.packages.items.total_customs_value.amount

number<float>

This is the monetary value..

Example:

99

collection.packages.items.total_customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

collection.packages.packaging

Packaging · object[]

Packaging data to be used to process the shipment.

Show child attributes

collection.packages.packaging.product

ProductRef · object

required

A reference to a Product object by id.

Show child attributes

collection.packages.packaging.product.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

collection.packages.packaging.product.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

collection.packages.packaging.quantity

integer

required

The product quantity in the package.

Example:

4

collection.packages.collected_data

CollectedData · object[]

Data collected for a shipment package.

Show child attributes

collection.packages.collected_data.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

collection.packages.collected_data.label

string

The label of the collected order item.

collection.packages.collected_data.value

string

The value of the collected order item.

collection.packages.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:32:28Z"

collection.packages.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

collection.packing_solution

ShipmentPackingSolution · object

The list of packaging solutions included in the shipment.
Optional Field

Show child attributes

collection.packing_solution.type

enum<string>

Available options:

ShipmentPackingSolution

collection.packing_solution.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

collection.packing_solution.containers

ShipmentPackingSolutionContainer · object[]

The list of containers that make up the shipment's packing solution.

Show child attributes

collection.packing_solution.containers.type

enum<string>

Available options:

ShipmentPackingSolutionContainer

collection.packing_solution.containers.weight

Weight · object

The weight of the container when packed with the shipment items.

Show child attributes

collection.packing_solution.containers.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.packing_solution.containers.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

collection.packing_solution.containers.dimensions

Dimensions · object

The dimensions of the container in imperial or metric units.

Show child attributes

collection.packing_solution.containers.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

collection.packing_solution.containers.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

collection.packing_solution.containers.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

collection.packing_solution.containers.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

collection.packing_solution.containers.volume

Volume · object

The total volume of the container in imperial or metric units.

Show child attributes

collection.packing_solution.containers.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

collection.packing_solution.containers.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

collection.packing_solution.containers.void_percent

number<float>

The percentage of void space remaining in the container after using the packing solution to pack the items.

Example:

15.23

collection.packing_solution.containers.regulation_type

enum<string>

The regulation type of which this container fulfills the packaging requirements.

Available options:

full,

orm-d,

limited,

small,

li-battery,

normal

collection.packing_solution.containers.items

ShipmentPackingSolutionContainerItem · object[]

The shipment items contained within the packaging.

Minimum array length: 1

Show child attributes

collection.packing_solution.containers.items.type

enum<string>

Available options:

ShipmentPackingSolutionContainerItem

collection.packing_solution.containers.items.sku

string

The SKU identifier for the product packed in the container.

Example:

"KDS2108"

collection.packing_solution.containers.items.quantity

integer

The quantity of a particular product within the packing solution's container.

Example:

2

collection.packing_solution.containers.items.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

collection.packing_solution.containers.items.order_item_sku

string

The product SKU associated with the container as it relates to the whole order.

Example:

"KDS2108"

collection.packing_solution.containers.items.order_item_qty

number<float>

The quantity of a product in the container as it relates to the whole order.

Example:

2

collection.packing_solution.containers.items.shipment_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

collection.packing_solution.containers.items.weight

Weight · object

The combined product weight within the container.

Show child attributes

collection.packing_solution.containers.items.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.packing_solution.containers.items.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

collection.picking_class_id

string

The ID for the Picking Class used for Bulk Fulfill Orders and Picking Batches.
Optional Field

Example:

"Default"

collection.is_cutoff_date_exception

boolean

Flag to indicate that a shipment has a cutoff date exception.
Optional Field

Example:

true

collection.is_manually_processed

boolean

Flag to indicate that a shipment is to be manually processed.
Optional Field

Example:

true

collection.label_print_target

string

The label printer ID used for the shipment.
Optional Field

Example:

"label001"

collection.scac

string

The Standard Carrier Alpha Code which can be found at https://en.wikipedia.org/wiki/Standard_Carrier_Alpha_Code
Optional Field

Example:

"FDEG"

collection.carrier_shipping_cost

number

The shipping cost given by the carrier.
Optional Field

Example:

3.9

collection.is_international

boolean

Flag to indicate that a shipment is using international shipping.
Optional Field

Example:

true

collection.is_documents_required

boolean

Flag to indicate that a shipment requires documents such as those for customs.
Optional Field

Example:

true

collection.is_electronic_customs

boolean

The flag indicates the presence of electronic customs documents, which will skip printing customs documents.
Optional Field

Example:

true

collection.infill_product_id

string

The SKU for the infill product to be used in the shipment.
Optional Field

Example:

"kraft"

collection.max_package_weight

number

The maximum package weight set for the shipment.
Optional Field

Example:

2.5

collection.packing_solution_providers

string[]

Packing solution providers for the shipment.
Optional Field

Example:

["Provider 1", "Provider 2"]

collection.tpb_group

string

The third party billing group for the shipment.
Optional Field

Example:

"ACME Inc"

collection.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

collection.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

collection.packed_at

string<date-time> | null

The date and time the Shipment was packed in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

collection.total_weight

Weight · object

The total weight of the shipment as measured or estimated based on the packages and their contents.

Show child attributes

collection.total_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

collection.total_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included

object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

Show child attributes

included.Brand

Brand · object[]

Show child attributes

included.Brand.type

enum<string>

Available options:

Brand

included.Brand.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Brand.code

string

The brand code may contain only letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.

Required string length: 1 - 32

Example:

"acme_inc"

included.Brand.name

string

Any string which uniquely identifies a Brand.

Required string length: 1 - 255

Example:

"ACME Inc."

included.Brand.is_active

boolean

This flag is true if the Brand is active.

Example:

true

included.Brand.is_deleted

boolean

This flag is true if the Brand has been deleted.

Example:

false

included.Brand.sort_order

number | null

The sort order property.

Example:

0

included.Merchant

Merchant · object[]

Show child attributes

included.Merchant.type

enum<string>

Available options:

Merchant

included.Merchant.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Merchant.code

string

Merchant code may only contain letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.

Required string length: 1 - 32

Example:

"acme_inc"

included.Merchant.name

string

Any string which uniquely identifies a Merchant.

Required string length: 1 - 64

Example:

"ACME Inc."

included.Merchant.status

enum<string> | null

default:active

Lifecycle status of the Merchant:

active: Merchant is operational and available for use
suspended: Temporarily on hold, can be easily reactivated
inactive: Long-term offline status, reactivation is possible but may require additional steps
archived: Soft delete status, manual recovery required

Available options:

active,

inactive,

suspended,

archived

Example:

"active"

included.Merchant.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Merchant.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Merchant.brands

BrandRef · object[]

A merchant must have one or more brands which may share the same pool of inventory. Brands can be used for customizing presentation and behaviors and often correspond to distinct lines of business or market presences.
Optional Field

Show child attributes

included.Merchant.brands.type

enum<string>

required

Available options:

Brand

included.Merchant.brands.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.Merchant.default_brand

BrandRef · object

This is the primary brand used when defining only the merchant for operations such as creating a new product.
Optional Field

Show child attributes

included.Merchant.default_brand.type

enum<string>

required

Available options:

Brand

included.Merchant.default_brand.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.Order

Order · object[]

Show child attributes

included.Order.type

enum<string>

Available options:

Order

included.Order.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Order.unique_id

string

The unique id for the order. This will be auto-assigned if not specified by the merchant at order creation time.

Required string length: 1 - 50

Example:

"1100000003"

included.Order.order_ref

string | null

An optional merchant-supplied reference for the order. Not a unique identifier.

Example:

"O-382227"

included.Order.state

enum<string>

This describes the high-level, overall progress of the order.

Available options:

new,

processing,

complete,

canceled,

holded

Example:

"new"

included.Order.status

enum<string> | null

This describes the low-level details of the current process of the order.

Available options:

new,

delayed_shipment,

holded,

partial_backorder,

backordered,

unresolved,

unable_to_process,

processing,

complete,

canceled,

invalid_address

Example:

"new"

included.Order.brand

Brand · object

The sub-level of a merchant which allows for separate customized configurations under the same merchant, such as packing slip designs, plugin subscriptions, etc.

Show child attributes

included.Order.brand.type

enum<string>

Available options:

Brand

included.Order.brand.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Order.brand.code

string

The brand code may contain only letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.

Required string length: 1 - 32

Example:

"acme_inc"

included.Order.brand.name

string

Any string which uniquely identifies a Brand.

Required string length: 1 - 255

Example:

"ACME Inc."

included.Order.brand.is_active

boolean

This flag is true if the Brand is active.

Example:

true

included.Order.brand.is_deleted

boolean

This flag is true if the Brand has been deleted.

Example:

false

included.Order.brand.sort_order

number | null

The sort order property.

Example:

0

included.Order.merchant

Merchant · object

This describes the owner or vendor of a particular line of products. There can be more than one product or brand for every merchant. And merchants can have their own shipping Rate Groups.

Show child attributes

included.Order.merchant.type

enum<string>

Available options:

Merchant

included.Order.merchant.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Order.merchant.code

string

Merchant code may only contain letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.

Required string length: 1 - 32

Example:

"acme_inc"

included.Order.merchant.name

string

Any string which uniquely identifies a Merchant.

Required string length: 1 - 64

Example:

"ACME Inc."

included.Order.merchant.status

enum<string> | null

default:active

Lifecycle status of the Merchant:

active: Merchant is operational and available for use
suspended: Temporarily on hold, can be easily reactivated
inactive: Long-term offline status, reactivation is possible but may require additional steps
archived: Soft delete status, manual recovery required

Available options:

active,

inactive,

suspended,

archived

Example:

"active"

included.Order.merchant.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Order.merchant.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Order.merchant.brands

BrandRef · object[]

Show child attributes

included.Order.merchant.brands.type

enum<string>

required

Available options:

Brand

included.Order.merchant.brands.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.Order.merchant.default_brand

BrandRef · object

This is the primary brand used when defining only the merchant for operations such as creating a new product.
Optional Field

Show child attributes

included.Order.merchant.default_brand.type

enum<string>

required

Available options:

Brand

included.Order.merchant.default_brand.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.Order.carrier_code

string

The carrier code of the assigned shipping method.

Example:

"fedex"

included.Order.shipping_method

string

The desired mode of transporting the shipment, which can either be a specific carrier and service, or a virtual method to select the optimal carrier and service for a specific criteria (e.g. Cheapest 2 Day, Cheapest All, etc.).

Example:

"fedex_FEDEX_2_DAY"

included.Order.signature_required

enum<string>

If a signature option is selected, this special service will instruct the carrier's driver to request a physical signature from the shipment recipient at the time of delivery. If it is not an available service, the shipping carrier will return an error when attempting to "Pack and Ship" the order.\

none No signature required.
any Direct signature required.
indirect Indirect signature required.
adult Adult signature required.
default The default option for the shipping method will be applied.

Available options:

none,

any,

indirect,

adult,

default

Example:

"adult"

included.Order.is_saturday_delivery

boolean

default:false

This flag will indicate whether saturday delivery is required. May not be applicable to all shipping methods or delivery areas.

included.Order.is_overbox_required

boolean

default:false

This flag will will direct the packer to use a packaging container that has "Satisfies Overbox" enabled.

included.Order.priority

integer

default:50

This order's priority. Setting the priority will boost or suppress this order's priority in relation to other orders for the same products. Lower numbers are higher in priority.

Required range: 0 <= x <= 100

included.Order.requested_ship_date

string<date> | null

Date when the order was requested to be shipped. If the order is Ready to Ship after the Service Level's Cutoff Time but before the Absolute Cutoff Time the Shipments may still receive the requested Target Ship Date and the Shipment's is_cutoff_date_exception flag will be true.

Example:

"2021-02-21"

included.Order.is_declared_value_service

boolean

default:false

Flag to indicate that a declared value service is required. If true then declared_value should also be set.

Example:

true

included.Order.declared_value

Monetary · object

If specified, is_declared_value_service must also be true. This is the maximum value of the products used to calculate shipping insurance.

Show child attributes

included.Order.declared_value.amount

number<float>

This is the monetary value..

Example:

99

included.Order.declared_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.Order.shipping_address

OrderAddress · object

The recipient's mailing address, phone number and email address. This also includes flags indicating the classification and validity of the address.

Show child attributes

included.Order.shipping_address.type

enum<string>

Available options:

OrderAddress

included.Order.shipping_address.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Order.shipping_address.first_name

string

The recipient's first name.

Maximum string length: 255

Example:

"Celina"

included.Order.shipping_address.last_name

string

The recipient's last name.

Maximum string length: 255

Example:

"Goalley"

included.Order.shipping_address.company

string

The recipient's company name (if applicable).

Maximum string length: 255

Example:

"Thompson-Torp"

included.Order.shipping_address.street

string[]

The recipient's building, apartment, or suite number then a street name.

Required array length: 1 - 4 elements

included.Order.shipping_address.city

string

The recipient's city or town name within a state, providence, or region.

Maximum string length: 255

Example:

"Springfield"

included.Order.shipping_address.region

string

The recipient's full state, providence, or region name.

Maximum string length: 255

Example:

"MO"

included.Order.shipping_address.postcode

string

This is a country-specific postal code (also known as zip code, post code, etc.) that can comprise of any number of alpha-numeric characters and hyphens. (e.g. 99999 or 99999-999, A9A 9A9).

Maximum string length: 255

Example:

"65807"

included.Order.shipping_address.country

string

An ISO 3166 alpha-2 country code.

Required string length: 2

Example:

"US"

included.Order.shipping_address.telephone

string

The phone number of the recipient including country code (e.g. +444175193773).

Maximum string length: 255

Example:

"(417) 123-4567"

included.Order.shipping_address.email

string<email> | null

The full email address of the recipient.

Maximum string length: 255

Example:

"[email protected]"

included.Order.shipping_address.classification

enum<string>

The type of address for the recipient which can affect rates and availability of shipping methods.

Available options:

res,

com,

po,

mil

Example:

"res"

included.Order.shipping_address.is_valid

boolean

This flag indicates whether or not the address has been validating using a third party address validator.

Example:

true

included.Order.items

OrderItem · object[]

A list of products with their stock movement statuses and quantities as they relate to an order.

Show child attributes

included.Order.items.type

enum<string>

Available options:

OrderItem

included.Order.items.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Order.items.sku

string

The SKU of the product being shipped in the order.

Example:

"KDS2108"

included.Order.items.order_item_ref

string | null

If required by your integration you may specify a reference to an external order item id.

included.Order.items.product

StockableProductRef · object

Reference a Product by id.

Show child attributes

included.Order.items.product.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Product,

PackagingContainer,

PackagingInfill,

PackagingSupplies

included.Order.items.product.id

integer<int32>

required

The internal, read-only, id property used as a path parameter in a resource lookup.

included.Order.items.qty_ordered

integer

Quantity of item ordered.

Required range: 1 <= x <= 999999

Example:

4

included.Order.items.qty_assigned

number<float>

Quantity of item assigned to a warehouse.

Required range: 0 <= x <= 999999.99999999

Example:

4

included.Order.items.qty_allocated

number<float>

Quantity of item allocated inventory.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.Order.items.qty_backordered

number<float>

Quantity of item back-ordered.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.Order.items.qty_processing

number<float>

Quantity of item ready to be picked.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.Order.items.qty_picked

number<float>

Quantity of item picked.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.Order.items.qty_shipped

number<float>

Quantity of item shipped.

Required range: 0 <= x <= 999999.99999999

Example:

4

included.Order.items.qty_cancel_requested

number<float>

Quantity of item requested to be canceled.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.Order.items.qty_canceled

number<float>

Quantity of item canceled.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.Order.items.row_weight

Weight · object

Total weight of the item.

Show child attributes

included.Order.items.row_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Order.items.row_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Order.shipments

(ShipmentRef · object | null)[]

A list of package groups that details their finalized shipping methods, warehouse origins, and packing solutions.

A Shipment represents one or more pickable items which may constitute a whole or part of an Order. Shipments are assigned directly to a Warehouse and may ultimately represent one or more packages once completed.

Show child attributes

included.Order.shipments.type

enum<string>

required

Available options:

Shipment

included.Order.shipments.id

integer

required

The internal id property used as a path parameter in a resource lookup.

included.Order.custom_greeting

string | null

If specified will override the configured Packing Slip default greeting. Allowing the addition of a Packing Slip Custom Greeting.
Optional Field

Maximum string length: 65535

included.Order.status_history

OrderStatusHistory · object[]

An order's status history and comments.
Optional Field

Show child attributes

included.Order.status_history.comment

string

required

An optional description for the history event which can be added programatically.

Maximum string length: 2048

Example:

"Changed shipping method to FedEx Ground"

included.Order.status_history.type

enum<string>

Available options:

OrderStatusHistory

included.Order.status_history.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Order.status_history.status

enum<string> | null

The status of the order at the time the history event was added.

Available options:

new,

delayed_shipment,

holded,

partial_backorder,

backordered,

unresolved,

unable_to_process,

processing,

complete,

canceled,

invalid_address

Example:

"new"

included.Order.status_history.notify_merchant

boolean | null

Set to true to notify the merchant, or false not to notify the merchant. Set to null or omit if a notification is not applicable.

included.Order.status_history.user

UserRef · object

Reference an OrganizationUser or ClientUser by id.

Show child attributes

included.Order.status_history.user.type

enum<string>

required

Available options:

OrganizationUser,

ClientUser

included.Order.status_history.user.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Order.status_history.script_id

integer<int32> | null

The ID of the script that added the comment.

included.Order.status_history.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:32:28Z"

included.Order.other_shipping_options

OrderOtherShippingOptions · object

This field allows for JSON code to be processed about an order at the time of shipping, such as updating an address, order status, or shipping method.\ Optional Field

Show child attributes

included.Order.other_shipping_options.virtual_excluded_services

string[] | null

An array of shipping methods or regular expressions to match against a shipping method.

Example:

["/^ups_/", "fedex_FEDEX_2_DAY"]

included.Order.duties_payor

DutiesPayor · object

Determines the party responsible for paying duties and taxes for international shipments.\ Optional Field

Show child attributes

included.Order.duties_payor.payor

enum<string> | null

default:default

default Use carrier configuration.
shipper Shipper pays duties.
recipient Recipient pays duties.
third_party Use Third Party Billing for paying duties.

Available options:

default,

shipper,

recipient,

third_party

Example:

"third_party"

included.Order.duties_payor.tpb_group_id

integer<int64> | null

The ID number of a Third Party Billing Account Group. If unset or null, and a default group is configured, the default group will be used. Set to 0 to disable third party billing.

Required range: x >= 1

Example:

3

included.Order.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Order.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.Order.completed_at

string<date-time>

The date and time the order was completed in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.OrderAddress

OrderAddress · object[]

Show child attributes

included.OrderAddress.type

enum<string>

Available options:

OrderAddress

included.OrderAddress.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.OrderAddress.first_name

string

The recipient's first name.

Maximum string length: 255

Example:

"Celina"

included.OrderAddress.last_name

string

The recipient's last name.

Maximum string length: 255

Example:

"Goalley"

included.OrderAddress.company

string

The recipient's company name (if applicable).

Maximum string length: 255

Example:

"Thompson-Torp"

included.OrderAddress.street

string[]

The recipient's building, apartment, or suite number then a street name.

Required array length: 1 - 4 elements

included.OrderAddress.city

string

The recipient's city or town name within a state, providence, or region.

Maximum string length: 255

Example:

"Springfield"

included.OrderAddress.region

string

The recipient's full state, providence, or region name.

Maximum string length: 255

Example:

"MO"

included.OrderAddress.postcode

string

This is a country-specific postal code (also known as zip code, post code, etc.) that can comprise of any number of alpha-numeric characters and hyphens. (e.g. 99999 or 99999-999, A9A 9A9).

Maximum string length: 255

Example:

"65807"

included.OrderAddress.country

string

An ISO 3166 alpha-2 country code.

Required string length: 2

Example:

"US"

included.OrderAddress.telephone

string

The phone number of the recipient including country code (e.g. +444175193773).

Maximum string length: 255

Example:

"(417) 123-4567"

included.OrderAddress.email

string<email> | null

The full email address of the recipient.

Maximum string length: 255

Example:

"[email protected]"

included.OrderAddress.classification

enum<string>

The type of address for the recipient which can affect rates and availability of shipping methods.

Available options:

res,

com,

po,

mil

Example:

"res"

included.OrderAddress.is_valid

boolean

This flag indicates whether or not the address has been validating using a third party address validator.

Example:

true

included.OrderItem

OrderItem · object[]

Show child attributes

included.OrderItem.type

enum<string>

Available options:

OrderItem

included.OrderItem.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.OrderItem.sku

string

The SKU of the product being shipped in the order.

Example:

"KDS2108"

included.OrderItem.order_item_ref

string | null

If required by your integration you may specify a reference to an external order item id.

included.OrderItem.product

StockableProductRef · object

Reference a Product by id.

Show child attributes

included.OrderItem.product.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Product,

PackagingContainer,

PackagingInfill,

PackagingSupplies

included.OrderItem.product.id

integer<int32>

required

The internal, read-only, id property used as a path parameter in a resource lookup.

included.OrderItem.qty_ordered

integer

Quantity of item ordered.

Required range: 1 <= x <= 999999

Example:

4

included.OrderItem.qty_assigned

number<float>

Quantity of item assigned to a warehouse.

Required range: 0 <= x <= 999999.99999999

Example:

4

included.OrderItem.qty_allocated

number<float>

Quantity of item allocated inventory.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.OrderItem.qty_backordered

number<float>

Quantity of item back-ordered.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.OrderItem.qty_processing

number<float>

Quantity of item ready to be picked.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.OrderItem.qty_picked

number<float>

Quantity of item picked.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.OrderItem.qty_shipped

number<float>

Quantity of item shipped.

Required range: 0 <= x <= 999999.99999999

Example:

4

included.OrderItem.qty_cancel_requested

number<float>

Quantity of item requested to be canceled.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.OrderItem.qty_canceled

number<float>

Quantity of item canceled.

Required range: 0 <= x <= 999999.99999999

Example:

0

included.OrderItem.row_weight

Weight · object

Total weight of the item.

Show child attributes

included.OrderItem.row_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.OrderItem.row_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.OrderStatusHistory

OrderStatusHistory · object[]

Show child attributes

included.OrderStatusHistory.comment

string

required

An optional description for the history event which can be added programatically.

Maximum string length: 2048

Example:

"Changed shipping method to FedEx Ground"

included.OrderStatusHistory.type

enum<string>

Available options:

OrderStatusHistory

included.OrderStatusHistory.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.OrderStatusHistory.status

enum<string> | null

The status of the order at the time the history event was added.

Available options:

new,

delayed_shipment,

holded,

partial_backorder,

backordered,

unresolved,

unable_to_process,

processing,

complete,

canceled,

invalid_address

Example:

"new"

included.OrderStatusHistory.notify_merchant

boolean | null

Set to true to notify the merchant, or false not to notify the merchant. Set to null or omit if a notification is not applicable.

included.OrderStatusHistory.user

UserRef · object

Reference an OrganizationUser or ClientUser by id.

Show child attributes

included.OrderStatusHistory.user.type

enum<string>

required

Available options:

OrganizationUser,

ClientUser

included.OrderStatusHistory.user.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.OrderStatusHistory.script_id

integer<int32> | null

The ID of the script that added the comment.

included.OrderStatusHistory.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:32:28Z"

included.PackagingContainer

PackagingContainer · object[]

Show child attributes

included.PackagingContainer.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingContainer

included.PackagingContainer.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingContainer.container_options

object

Show child attributes

included.PackagingContainer.container_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingContainer.container_options.weight

Weight · object

The weight of the container when packed with the shipment items.

Show child attributes

included.PackagingContainer.container_options.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingContainer.container_options.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingContainer.container_options.dimensions

Dimensions · object

The dimensions of the container in imperial or metric units.

Show child attributes

included.PackagingContainer.container_options.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

included.PackagingContainer.container_options.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

included.PackagingContainer.container_options.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

included.PackagingContainer.container_options.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.PackagingContainer.container_options.volume

Volume · object

The total volume of the container in imperial or metric units.

Show child attributes

included.PackagingContainer.container_options.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

included.PackagingContainer.container_options.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

included.PackagingContainer.container_options.manage_stock

enum<boolean>

This flag indicates whether or not to adjust the inventory quantity of the packaging feature with each use. If true then the inventory levels will decrease with each use. If no then the inventory will not adjust with each use.

Available options:

true,

false

included.PackagingContainer.container_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingContainer.container_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingContainer.container_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingContainer.container_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingContainer.container_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingContainer.container_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingContainer.container_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingContainer.container_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingContainer.container_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingContainer.container_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingContainer.container_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingContainer.container_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingContainer.container_options.allow_for_warehouses

(WarehouseRef · object | null)[]

If specified, this packaging feature will only be applicable to the selected warehouses.

A reference to a Warehouse by id.

Show child attributes

included.PackagingContainer.container_options.allow_for_warehouses.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

included.PackagingContainer.container_options.allow_for_warehouses.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.PackagingContainer.container_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingContainer.container_options.satisfies_overbox

enum<boolean>

Will be a valid container for products which have Requires Overbox: Yes.

Available options:

true,

false

included.PackagingContainer.container_options.use_for_bin_packing

enum<string>

Containers with "Use for Bin Packing: No" will not be used by packing solution providers.

Available options:

yes,

no,

fallback

included.PackagingContainer.container_options.weight_capacity

Weight · object

Maximum allowed weight of the container, including tare weight. Optional Field

Show child attributes

included.PackagingContainer.container_options.weight_capacity.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingContainer.container_options.weight_capacity.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingContainer.container_options.container_style

enum<string>

Specify the container type. Currently, only "Rigid Box" is supported.

Available options:

rigid_box

included.PackagingContainer.container_options.packaging_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable for this packaging feature (e.g. cylindrical, non-fiberboard material, protrusions, non-conveyable, etc.)

Available options:

true,

false

included.PackagingContainer.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingContainer.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingContainer.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingContainer.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingContainer.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingContainer.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingContainer.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingContainer.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingDataCollection

PackagingDataCollection · object[]

Show child attributes

included.PackagingDataCollection.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingDataCollection.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingDataCollection.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingDataCollection.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingDataCollection.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingDataCollection.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingDataCollection.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingDataCollection.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingDataCollection.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingDataCollection

included.PackagingDataCollection.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingDataCollection.data_collection_options

object

Show child attributes

included.PackagingDataCollection.data_collection_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingDataCollection.data_collection_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingDataCollection.data_collection_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingDataCollection.data_collection_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingDataCollection.data_collection_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingDataCollection.data_collection_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingDataCollection.data_collection_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingDataCollection.data_collection_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingDataCollection.data_collection_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingDataCollection.data_collection_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingDataCollection.data_collection_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingDataCollection.data_collection_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingDataCollection.data_collection_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingDataCollection.data_collection_options.apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments containing an item with this Goods Type. \

NORMAL Not Regulated
ORM_D ORM-D Optional Field

Available options:

any,

NORMAL,

ORM_D

included.PackagingDataCollection.data_collection_options.never_apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type. \

NORMAL Not Regulated
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated Optional Field

Available options:

NORMAL,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.PackagingDataCollection.data_collection_options.apply_only_above_weight

Weight · object

If specified, this packaging product is not a requirement for packages under the given weight when "Always/Never Apply to Goods Type" is specified. Optional Field

Show child attributes

included.PackagingDataCollection.data_collection_options.apply_only_above_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingDataCollection.data_collection_options.apply_only_above_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingDataCollection.data_collection_options.one_per

enum<string>

The expected number of scans per shipment. The product "Unit Quantity" is used as a multiplier for "One Scan Per: Each".

Available options:

order,

package,

item,

each

included.PackagingDataCollection.data_collection_options.require_scan_timing

enum<string>

Choose how the scan timer should begin recording time data on this product or packaging feature.

Available options:

after_product_scan|on_full,

on_start

included.PackagingDataCollection.data_collection_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingDataCollection.data_collection_options.require_packaging_type

enum<string>

If specified, this packaging feature will only be applicable when the container meets the chosen criteria based on the container's "Satisfies Overbox" attribute when "Always/Never Apply to Goods Type" is specified.

Available options:

overbox,

non_overbox

included.PackagingDataCollection.data_collection_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingDataCollection.data_collection_options.apply_to_multi_sku_package

enum<boolean>

If "Yes", this packaging product will only be applied to packages containing more than one SKU when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingDataCollection.data_collection_options.collect_data_pattern

string

Specify a Javascript-compatible regular expression which describes the format of the data to be collected. Examples: ".+" for anything, or "^[0-9]{15}$" for a 15-digit number. See http://regexpal.com/

included.PackagingDataCollection.data_collection_options.apply_to_region

string

Unless specified, this packaging feature will apply to all regions when "Always/Never Apply to Goods Type" is specified.

included.PackagingDataCollection.data_collection_options.is_collected_data_unique

enum<boolean>

Prevent the same data collection value from being collected more than once on the same shipment.

Available options:

true,

false

included.PackagingInfill

PackagingInfill · object[]

Show child attributes

included.PackagingInfill.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingInfill

included.PackagingInfill.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingInfill.infill_options

object

Show child attributes

included.PackagingInfill.infill_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingInfill.infill_options.weight

Weight · object

The weight of the infill. Optional Field

Show child attributes

included.PackagingInfill.infill_options.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingInfill.infill_options.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingInfill.infill_options.manage_stock

enum<boolean>

Available options:

true,

false

included.PackagingInfill.infill_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingInfill.infill_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingInfill.infill_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingInfill.infill_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInfill.infill_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInfill.infill_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInfill.infill_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInfill.infill_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInfill.infill_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInfill.infill_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingInfill.infill_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingInfill.infill_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingInfill.infill_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingInfill.infill_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingInfill.infill_options.is_confirmation_required

enum<boolean>

If "Yes", this packer will be prompted and required to confirm the use of infill.

Available options:

true,

false

included.PackagingInfill.infill_options.infill_horizontal

Length · object

The amount of space to reserve on each horizontal side of the package for infill.
Optional Field

Show child attributes

included.PackagingInfill.infill_options.infill_horizontal.value

number<float>

This value describes the length of the object as a floating-point number up to 4 decimal places.

Example:

12

included.PackagingInfill.infill_options.infill_horizontal.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.PackagingInfill.infill_options.infill_vertical

Length · object

The amount of space to reserve on each vertical side of the package for infill. Optional Field

Show child attributes

included.PackagingInfill.infill_options.infill_vertical.value

number<float>

This value describes the length of the object as a floating-point number up to 4 decimal places.

Example:

12

included.PackagingInfill.infill_options.infill_vertical.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.PackagingInfill.infill_options.infill_priority

integer

If multiple infill types are prescribed for a mix of items, the infill with the lowest Infill Priority number will prevail.

included.PackagingInfill.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingInfill.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingInfill.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingInfill.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingInfill.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingInfill.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInfill.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingInfill.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingInstruction

PackagingInstruction · object[]

Show child attributes

included.PackagingInstruction.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingInstruction

included.PackagingInstruction.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingInstruction.instruction_options

object

Show child attributes

included.PackagingInstruction.instruction_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingInstruction.instruction_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingInstruction.instruction_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingInstruction.instruction_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingInstruction.instruction_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInstruction.instruction_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInstruction.instruction_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInstruction.instruction_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingInstruction.instruction_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingInstruction.instruction_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInstruction.instruction_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingInstruction.instruction_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingInstruction.instruction_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingInstruction.instruction_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingInstruction.instruction_options.apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments containing an item with this Goods Type.

NORMAL Not Regulated
ORM_D ORM-D Optional Field

Available options:

any,

NORMAL,

ORM_D

included.PackagingInstruction.instruction_options.never_apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.

NORMAL Not Regulated
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated Optional Field

Available options:

NORMAL,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.PackagingInstruction.instruction_options.apply_only_above_weight

Weight · object

If specified, this packaging product is not a requirement for packages under the given weight when "Always/Never Apply to Goods Type" is specified.
Optional Field

Show child attributes

included.PackagingInstruction.instruction_options.apply_only_above_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingInstruction.instruction_options.apply_only_above_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingInstruction.instruction_options.one_per

enum<string>

The expected number of scans per shipment. The product "Unit Quantity" is used as a multiplier for "One Scan Per: Each".

Available options:

order,

package,

item,

each

included.PackagingInstruction.instruction_options.require_scan_timing

enum<string>

Choose how the scan timer should begin recording time data on this product or packaging feature.

Available options:

after_product_scan|on_full,

on_start

included.PackagingInstruction.instruction_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingInstruction.instruction_options.require_packaging_type

enum<string>

Available options:

overbox,

non_overbox

included.PackagingInstruction.instruction_options.apply_to_region

string

Unless specified, this packaging feature will apply to all regions when "Always/Never Apply to Goods Type" is specified.

included.PackagingInstruction.instruction_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingInstruction.instruction_options.apply_to_multi_sku_package

enum<boolean>

If "Yes", this packaging product will only be applied to packages containing more than one SKU when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingInstruction.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingInstruction.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingInstruction.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingInstruction.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingInstruction.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingInstruction.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingInstruction.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingInstruction.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.PackagingSupplies

PackagingSupplies · object[]

Show child attributes

included.PackagingSupplies.type

enum<string>

This property describes the type of object in the response body.

Available options:

PackagingSupplies

included.PackagingSupplies.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.PackagingSupplies.supplies_options

object

Show child attributes

included.PackagingSupplies.supplies_options.barcodes

A comma separated list of unique packaging feature barcodes.
Optional Field

Example:

"956623520-4"

included.PackagingSupplies.supplies_options.weight

Weight · object

The weight of the infill. Optional Field

Show child attributes

included.PackagingSupplies.supplies_options.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingSupplies.supplies_options.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingSupplies.supplies_options.manage_stock

enum<boolean>

Available options:

true,

false

included.PackagingSupplies.supplies_options.associated_products

ProductRef · object[]

A list of products with this packaging feature selected in its "Other Special Features" option in the product's "Packaging" tab.

Show child attributes

included.PackagingSupplies.supplies_options.associated_products.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.PackagingSupplies.supplies_options.associated_products.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.PackagingSupplies.supplies_options.allow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will only be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingSupplies.supplies_options.allow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingSupplies.supplies_options.allow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingSupplies.supplies_options.disallow_for_brands

(MerchantRef · object | BrandRef · object)[]

If specified, this packaging feature will not be applicable to the selected merchants/brands.

Reference a Merchant by id.

MerchantRef
BrandRef

Show child attributes

included.PackagingSupplies.supplies_options.disallow_for_brands.type

enum<string>

required

Available options:

Merchant

included.PackagingSupplies.supplies_options.disallow_for_brands.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingSupplies.supplies_options.billing_amount

Monetary · object

The amount that will be billable for consumption of one unit of this packaging feature.
Optional Field

Show child attributes

included.PackagingSupplies.supplies_options.billing_amount.amount

number<float>

This is the monetary value..

Example:

99

included.PackagingSupplies.supplies_options.billing_amount.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.PackagingSupplies.supplies_options.allow_for_warehouses

(WarehouseRef · object | null)[]

If specified, this packaging feature will only be applicable to the selected warehouses.

A reference to a Warehouse by id.

Show child attributes

included.PackagingSupplies.supplies_options.allow_for_warehouses.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

included.PackagingSupplies.supplies_options.allow_for_warehouses.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.PackagingSupplies.supplies_options.allow_for_shipping_methods

string[]

If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.

included.PackagingSupplies.supplies_options.packaging_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable for this packaging feature (e.g. cylindrical, non-fiberboard material, protrusions, non-conveyable, etc.)

Available options:

true,

false

included.PackagingSupplies.supplies_options.apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.

NORMAL Not Regulated
ORM_D ORM-D Optional Field

Available options:

any,

NORMAL,

ORM_D

included.PackagingSupplies.supplies_options.never_apply_to_goods_type

enum<string>

This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.

NORMAL Not Regulated
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated Optional Field

Available options:

NORMAL,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.PackagingSupplies.supplies_options.apply_only_above_weight

Weight · object

If specified, this packaging supply is not a requirement for packages under the given weight when "Always/Never Apply to Goods Type" is specified. Optional Field

Show child attributes

included.PackagingSupplies.supplies_options.apply_only_above_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.PackagingSupplies.supplies_options.apply_only_above_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.PackagingSupplies.supplies_options.one_per

enum<string>

The expected number of scans per shipment. The product "Unit Quantity" is used as a multiplier for "One Scan Per: Each".

Available options:

order,

package,

item,

each

included.PackagingSupplies.supplies_options.require_scan_timing

enum<string>

Choose how the scan timer should begin recording time data on this product or packaging feature.

Available options:

after_product_scan|on_full,

on_start

included.PackagingSupplies.supplies_options.disable_confirm_button

enum<boolean>

If "No", the user will be able to tap "Confirm" rather than scanning a barcode.

Available options:

true,

false

included.PackagingSupplies.supplies_options.require_packaging_type

enum<string>

Available options:

overbox,

non_overbox

included.PackagingSupplies.supplies_options.apply_to_region

string

Unless specified, this packaging feature will apply to all regions when "Always/Never Apply to Goods Type" is specified.

included.PackagingSupplies.supplies_options.apply_unless_container_meets_hazmat

enum<boolean>

If "Yes", this packaging product will be applicable unless a package contains a DG item with "Container Meets Hazmat Specs: Yes" when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingSupplies.supplies_options.apply_to_multi_sku_package

enum<boolean>

If "Yes", this packaging product will only be applied to packages containing more than one SKU when "Always/Never Apply to Goods Type" is specified.

Available options:

true,

false

included.PackagingSupplies.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.PackagingSupplies.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.PackagingSupplies.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.PackagingSupplies.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.PackagingSupplies.merchant.type

enum<string>

required

Available options:

Merchant

included.PackagingSupplies.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.PackagingSupplies.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.PackagingSupplies.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.Product

(Product · object | PackagingContainer · object | PackagingSupplies · object | PackagingInfill · object)[]

A Product contains information about a sellable item.

Product
PackagingContainer
PackagingSupplies
PackagingInfill

Show child attributes

included.Product.type

enum<string>

This property describes the type of object in the response body.

Available options:

Product

included.Product.id

integer

The internal, read-only, id property used as a path parameter in a resource lookup.

included.Product.vendor_sku

string | null

For informational use only. Displayed during delivery processing to help match products.
Optional Field

Example:

"Vendor-SKU-1AD2"

included.Product.external_id

string | null

May be used for external product sync.

Example:

"11-993-9048"

included.Product.barcodes

A comma separated list of unique packaging feature barcodes.

Example:

["956623520-4", "O-VS-Oregano-p3"]

included.Product.goods_type

enum<string>

This defines the regulations, if any, assigned to a Product.

NORMAL Not Regulated
ORM_D ORM-D
LIMITED_QUANTITIES_COMMODITIES Limited Quantities: Consumer Commodity
HAZMAT Regulated

Available options:

NORMAL,

ORM_D,

LIMITED_QUANTITIES_COMMODITIES,

HAZMAT

included.Product.is_available

enum<boolean>

default:true

This flag must be true to allow the Product to be ordered.

Available options:

true,

false

included.Product.is_visible

enum<boolean>

default:true

This flag must be true to show the Product in the inventory feed.

Available options:

true,

false

included.Product.lot_type

LotTypeRef · object

This LotType determines how a Product should be "burned" and whether lots with dissimilar data can be "mixed".
Optional Field

Show child attributes

included.Product.lot_type.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

LotType

included.Product.lot_type.id

integer<int64>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Product.weight

Weight · object

This object defines the weight of the Product in imperial or metric units.
Optional Field

Show child attributes

included.Product.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Product.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Product.dimensions

Dimensions · object

This object defines the length, width, and height of the Product in imperial or metric units.
Optional Field

Show child attributes

included.Product.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

included.Product.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

included.Product.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

included.Product.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.Product.volume

Volume · object

This object defines the cubic size of the Product in imperial or metric units.
Optional Field

Show child attributes

included.Product.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

included.Product.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

included.Product.inventory

Inventory · object

This object describes how the Product Stock is defined, such as real config values, or Virtual Inventory, and how to handle Backorders.
Optional Field

Show child attributes

included.Product.inventory.backorders

This determines if Product that is no longer in stock may be backordered or whether or not to use ShipStream's scoped configurations.

Example:

true

included.Product.inventory.dynamic_allocation

This will allow the Product to source from inventory in other warehouses in real-time if enabled, and can be set to use ShipStream's scoped configurations.

Example:

true

included.Product.inventory.virtual_inventory

enum<string>

This is the method used to predict an esitmate of inventory available when kitting from the Product.

Available options:

none,

optimistic,

realistic,

pessimistic

Example:

"optimistic"

included.Product.export

Export · object

This object contains fields for describing and codifying an internationally exportable Product.
Optional Field

Show child attributes

included.Product.export.description

string | null

This is used to describe in detail the Product for international shipping and customs regulations.

Example:

"Plastic children's toy with steel weights and ball bearings"

included.Product.export.customs_value

Monetary · object

The value of the products the purpose of calculating duties and taxes in the destination country.

Show child attributes

included.Product.export.customs_value.amount

number<float>

This is the monetary value..

Example:

99

included.Product.export.customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.Product.export.country_of_manufacture

string | null

2 letters Country ISO Code

Example:

"TW"

included.Product.export.hs_base_code

string | null

This is the Harmonized System Code (HS Code); a standardized numerical method of classifying traded products. These are 6 digit codes in the format ###.## which are associated with a standard HS Code Description.

Example:

"8518.30"

included.Product.export.hs_country_extension

object[] | null

Show child attributes

included.Product.export.hs_country_extension.country_id

string

This is the two-digit ISO (Alpha-2) country code.

included.Product.export.hs_country_extension.extension

string

This is the Schedule C Country Code; a 4 digit code that identifies a country.

Example:

[
  { "country_id": "TW", "extension": "002" },
  { "country_id": "US", "extension": "011" }
]

included.Product.regulated_goods

RegulatedGoods · object

This object only applies a Product using the "Regulated" Goods Type, and describes the Regulation and container specifications for the Product.
Optional Field

Show child attributes

included.Product.regulated_goods.regulation

Regulation · object

A reference to a Regulation by id.

Show child attributes

included.Product.regulated_goods.regulation.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Regulation

included.Product.regulated_goods.regulation.id

integer

required

The internal id property used as a path parameter in a resource lookup.

included.Product.regulated_goods.technical_name

string | null

Must match against Regulation's Technical Name Pattern if specified.

Example:

"Hydro Polymer Acetylene Coating"

included.Product.regulated_goods.additional_information

string | null

Must match against Regulation's Additional Regulatory Information Pattern if specified.

Example:

"Flamable Liquid"

included.Product.regulated_goods.net_weight

Weight · object

Show child attributes

included.Product.regulated_goods.net_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Product.regulated_goods.net_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Product.regulated_goods.container_type

string | null

The Overpack Container Type can be a combination of material and container type such as Aluminum Box, Steel Drum, or a combination of a material and container type from these two lists:

Material: Aluminum, Fiberboard, Glass, Plywood, Plastic, Steel, Wood
Container: Bag, Bottle, Box, Bucket, Cylinder, Drum, Jerrican, Pail

Example:

"Plastic Box"

included.Product.regulated_goods.container_meets_hazmat_specs

boolean

This flag indicates that the RegulatedGoods container is sufficient for a regulated (HAZMAT) product.

Example:

true

included.Product.regulated_goods.regulation_units

number<float>

These units are arbitrary and should be relative to the Regulation's Pickup Weight Limit. E.g. it could be in pounds, kilowatt/hours, etc.

Example:

5

included.Product.packaging

Packaging · object

This object defines how the shipping container/box for the Product is to be processed and whether there are any special instructions during packing.
Optional Field

Show child attributes

included.Product.packaging.require_packaging

enum<boolean>

If Yes, packaging will require a Box with "Satisfies Overbox: Yes".

Available options:

true,

false

Example:

true

included.Product.packaging.require_weight_check

enum<boolean>

If Yes, the associated product will require the use of a scale to verify that the package's weight falls within the expected amount. If this is set to No, this step will be skipped by the packer.

Available options:

true,

false

Example:

true

included.Product.packaging.require_confirmation_per_item

enum<boolean>

If Yes, Packaging Products with "One Scan Per: Item" will require a scan for each item packed rather than just one for the first item in a package.

Available options:

true,

false

Example:

true

included.Product.packaging.unit_quantity

integer | null

Number of individually packaged items contained therein for purposes of special packaging features.

Example:

1

included.Product.packaging.bulk_quantity

integer | null

Prefer to split into packages when necessary using multiples of this amount.

Example:

10

included.Product.packaging.max_per_package

integer | null

The maximum quantity of this product to ever include in the same package. Multiply by "Unit Quantity" to achieve common units between other products with the same "Ship Separate Tag" value.

Example:

15

included.Product.packaging.is_ship_separately

enum<boolean>

This item cannot ship in the same package as other items (unless they have the same "Ship Separate Tag").

Available options:

true,

false

Example:

true

included.Product.packaging.ship_separately_tag

string | null

Applies only if "Ship Separate" is "Yes". Assign the same tag to treat similar products as interchangeable with respect to the "Ship Separate" and "Max Per Package" attribute.

Example:

"PVC"

included.Product.packaging.can_tip

enum<boolean>

If Yes, the item is allowed to be rotated vertically when packed.

Available options:

true,

false

Example:

true

included.Product.packaging.can_contain_other_items

enum<boolean>

If Yes then other smaller items are allowed to be placed within this larger item. This is useful when the item is hollow or is a bin/bucket.

Available options:

true,

false

Example:

true

included.Product.packaging.is_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable when shipped without an Overbox.

Available options:

true,

false

Example:

true

included.Product.custom_fields

(object | null)[]

This will set any Product Attributes, pre-defined by the user, for the Product.
Optional Field

Example:

[
  {
    "code": "color",
    "value": 13,
    "label": "Red and Black"
  },
  { "code": "cost_of_goods", "value": 41.32 },
  { "code": "allow_mailer", "value": true }
]

included.Product.sku

string

The Stock Keeping Unit (SKU) is a unique identifier for the Product.

Example:

"SKU-1AD"

included.Product.name

string

This is displayed as a short, descriptive title for the Product.

Example:

"Test Product"

included.Product.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

included.Product.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

included.Product.merchant.type

enum<string>

required

Available options:

Merchant

included.Product.merchant.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Product.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Product.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:39:43Z"

included.Shipment

Shipment · object[]

Show child attributes

included.Shipment.type

enum<string>

Available options:

Shipment

included.Shipment.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Shipment.unique_id

string

A unique ID for the shipment. This number may appear on the packing slip as the "Packing Slip #".

Example:

"1100000003"

included.Shipment.external_id

string

An arbitrary string to use as an external reference ID.

Maximum string length: 64

included.Shipment.status

enum<string>

The shipment status indicates which stage the shipment is in.

Available options:

new,

picking,

picked,

packing,

packed,

loaded,

canceled,

voided,

packing_exception,

shipped

Example:

"new"

included.Shipment.shipping_carrier_code

string

The ShipStream carrier code for the shipment. This will always be the same as the prefix for the shipping_service_code.

Example:

"fedex"

included.Shipment.shipping_method

string

included.Shipment.shipping_method_name

string

The name of the shipping method.
Optional Field

included.Shipment.shipping_service_code

string

The order was updated after the shipment was packed
A Virtual Shipping Method was used to assign a shipping method based on rate shopping
A Preprocess Packing Solution Script was used to assign a specific shipping method

included.Shipment.shipping_service_name

string

The human-friendly name of the shipping service assigned to this shipment. This value is the same as the label returned by the shipping/shipping_method Enumeration.

Example:

"fedex_FEDEX_2_DAY"

included.Shipment.warehouse

WarehouseRef · object

A reference to a Warehouse by id.

Show child attributes

included.Shipment.warehouse.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

included.Shipment.warehouse.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.Shipment.order

OrderRef · object

A reference to an Order by id.

Show child attributes

included.Shipment.order.type

enum<string>

required

Available options:

Order

included.Shipment.order.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.Shipment.shipping_account

ShippingAccount · object

The shipping account used to submit this shipment.
Optional Field

Show child attributes

included.Shipment.shipping_account.type

enum<string>

required

Available options:

ShippingAccount

included.Shipment.shipping_account.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Shipment.target_ship_date

string<date> | null

The date that the shipment is scheduled to be completed.
Optional Field

included.Shipment.item_weight

Weight · object

The total weight of all shipment items (does not include packaging).
Optional Field

Show child attributes

included.Shipment.item_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.item_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Shipment.shipped_weight

Weight · object

The weight of all shipment items and packaging at the time of shipping.
Optional Field

Show child attributes

included.Shipment.shipped_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.shipped_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Shipment.items

ShipmentItem · object[]

A list of items belonging to the Shipment.
Optional Field

Minimum array length: 1

Show child attributes

included.Shipment.items.type

enum<string>

required

Available options:

ShipmentItem

included.Shipment.items.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.Shipment.items.product

ProductRef · object

The Product this shipment line-item refers to.

Show child attributes

included.Shipment.items.product.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.Shipment.items.product.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Shipment.packages

ShipmentPackage · object[]

The list of packages included in the shipment.
Optional Field

Show child attributes

included.Shipment.packages.items

object[]

A list of items contained within the ShipmentPackage.

Minimum array length: 1

Show child attributes

included.Shipment.packages.items.sku

string

The SKU identifier for the product contained in the package.

Example:

"KDS2108"

included.Shipment.packages.items.quantity

integer

The quantity of a particular product in a package.

Example:

2

included.Shipment.packages.items.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Shipment.packages.items.order_item_sku

string

The SKU identifier for the product as it relates to the shipment in an order.

Example:

"KDS2108"

included.Shipment.packages.items.order_item_qty

number<float>

The quantity of a product in the shipment of an order.

Example:

2

included.Shipment.packages.items.shipment_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Shipment.packages.items.weight

Weight · object

The combined weight of the the same items in the package.

Show child attributes

included.Shipment.packages.items.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.packages.items.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Shipment.packages.items.hazmat_unit_weight

Weight · object

The combined weight of the same items in thie package formatted for hazmat inspection.

Show child attributes

included.Shipment.packages.items.hazmat_unit_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.packages.items.hazmat_unit_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Shipment.packages.items.total_customs_value

Monetary · object

The combined value of the same items in the package.

Show child attributes

included.Shipment.packages.items.total_customs_value.amount

number<float>

This is the monetary value..

Example:

99

included.Shipment.packages.items.total_customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.Shipment.packages.packaging

Packaging · object[]

Packaging data to be used to process the shipment.

Show child attributes

included.Shipment.packages.packaging.product

ProductRef · object

required

A reference to a Product object by id.

Show child attributes

included.Shipment.packages.packaging.product.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.Shipment.packages.packaging.product.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Shipment.packages.packaging.quantity

integer

required

The product quantity in the package.

Example:

4

included.Shipment.packages.collected_data

CollectedData · object[]

Data collected for a shipment package.

Show child attributes

included.Shipment.packages.collected_data.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Shipment.packages.collected_data.label

string

The label of the collected order item.

included.Shipment.packages.collected_data.value

string

The value of the collected order item.

included.Shipment.packages.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:32:28Z"

included.Shipment.packages.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Shipment.packing_solution

ShipmentPackingSolution · object

The list of packaging solutions included in the shipment.
Optional Field

Show child attributes

included.Shipment.packing_solution.type

enum<string>

Available options:

ShipmentPackingSolution

included.Shipment.packing_solution.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Shipment.packing_solution.containers

ShipmentPackingSolutionContainer · object[]

The list of containers that make up the shipment's packing solution.

Show child attributes

included.Shipment.packing_solution.containers.type

enum<string>

Available options:

ShipmentPackingSolutionContainer

included.Shipment.packing_solution.containers.weight

Weight · object

The weight of the container when packed with the shipment items.

Show child attributes

included.Shipment.packing_solution.containers.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.packing_solution.containers.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Shipment.packing_solution.containers.dimensions

Dimensions · object

The dimensions of the container in imperial or metric units.

Show child attributes

included.Shipment.packing_solution.containers.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

included.Shipment.packing_solution.containers.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

included.Shipment.packing_solution.containers.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

included.Shipment.packing_solution.containers.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.Shipment.packing_solution.containers.volume

Volume · object

The total volume of the container in imperial or metric units.

Show child attributes

included.Shipment.packing_solution.containers.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

included.Shipment.packing_solution.containers.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

included.Shipment.packing_solution.containers.void_percent

number<float>

The percentage of void space remaining in the container after using the packing solution to pack the items.

Example:

15.23

included.Shipment.packing_solution.containers.regulation_type

enum<string>

The regulation type of which this container fulfills the packaging requirements.

Available options:

full,

orm-d,

limited,

small,

li-battery,

normal

included.Shipment.packing_solution.containers.items

ShipmentPackingSolutionContainerItem · object[]

The shipment items contained within the packaging.

Minimum array length: 1

Show child attributes

included.Shipment.packing_solution.containers.items.type

enum<string>

Available options:

ShipmentPackingSolutionContainerItem

included.Shipment.packing_solution.containers.items.sku

string

The SKU identifier for the product packed in the container.

Example:

"KDS2108"

included.Shipment.packing_solution.containers.items.quantity

integer

The quantity of a particular product within the packing solution's container.

Example:

2

included.Shipment.packing_solution.containers.items.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Shipment.packing_solution.containers.items.order_item_sku

string

The product SKU associated with the container as it relates to the whole order.

Example:

"KDS2108"

included.Shipment.packing_solution.containers.items.order_item_qty

number<float>

The quantity of a product in the container as it relates to the whole order.

Example:

2

included.Shipment.packing_solution.containers.items.shipment_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Shipment.packing_solution.containers.items.weight

Weight · object

The combined product weight within the container.

Show child attributes

included.Shipment.packing_solution.containers.items.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.packing_solution.containers.items.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Shipment.picking_class_id

string

The ID for the Picking Class used for Bulk Fulfill Orders and Picking Batches.
Optional Field

Example:

"Default"

included.Shipment.is_cutoff_date_exception

boolean

Flag to indicate that a shipment has a cutoff date exception.
Optional Field

Example:

true

included.Shipment.is_manually_processed

boolean

Flag to indicate that a shipment is to be manually processed.
Optional Field

Example:

true

included.Shipment.label_print_target

string

The label printer ID used for the shipment.
Optional Field

Example:

"label001"

included.Shipment.scac

string

The Standard Carrier Alpha Code which can be found at https://en.wikipedia.org/wiki/Standard_Carrier_Alpha_Code
Optional Field

Example:

"FDEG"

included.Shipment.carrier_shipping_cost

number

The shipping cost given by the carrier.
Optional Field

Example:

3.9

included.Shipment.is_international

boolean

Flag to indicate that a shipment is using international shipping.
Optional Field

Example:

true

included.Shipment.is_documents_required

boolean

Flag to indicate that a shipment requires documents such as those for customs.
Optional Field

Example:

true

included.Shipment.is_electronic_customs

boolean

The flag indicates the presence of electronic customs documents, which will skip printing customs documents.
Optional Field

Example:

true

included.Shipment.infill_product_id

string

The SKU for the infill product to be used in the shipment.
Optional Field

Example:

"kraft"

included.Shipment.max_package_weight

number

The maximum package weight set for the shipment.
Optional Field

Example:

2.5

included.Shipment.packing_solution_providers

string[]

Packing solution providers for the shipment.
Optional Field

Example:

["Provider 1", "Provider 2"]

included.Shipment.tpb_group

string

The third party billing group for the shipment.
Optional Field

Example:

"ACME Inc"

included.Shipment.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Shipment.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Shipment.packed_at

string<date-time> | null

The date and time the Shipment was packed in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Shipment.total_weight

Weight · object

The total weight of the shipment as measured or estimated based on the packages and their contents.

Show child attributes

included.Shipment.total_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.Shipment.total_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.ShipmentItem

ShipmentItem · object[]

Show child attributes

included.ShipmentItem.type

enum<string>

Available options:

ShipmentItem

included.ShipmentItem.id

integer

The internal id property used as a path parameter in a resource lookup.

included.ShipmentItem.sku

string

The product SKU within the shipment.

Example:

"KDS2108"

included.ShipmentItem.product

StockableProductRef · object

A reference to a Product or stockable packaging type object by id.

Show child attributes

included.ShipmentItem.product.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Product,

PackagingContainer,

PackagingInfill,

PackagingSupplies

included.ShipmentItem.product.id

integer<int32>

required

The internal, read-only, id property used as a path parameter in a resource lookup.

included.ShipmentItem.quantity

integer

The product quantity in the shipment.

Example:

4

included.ShipmentItem.qty_shipped

integer

The quantity of a product's inventory in a shipment that has been shipped.

Example:

4

included.ShipmentItem.qty_picked

integer

The quantity of a product's inventory in a shipment that was picked from a location.

Example:

0

included.ShipmentItem.qty_canceled

integer

The quantity of a product's inventory in a shipment that was canceled.

Example:

0

included.ShipmentItem.qty_cancel_requested

integer

The quantity of a product's inventory in a shipment that is in the process of being canceled.

Example:

0

included.ShipmentItem.order_item

OrderItem · object

Show child attributes

included.ShipmentItem.order_item.type

enum<string>

required

Available options:

OrderItem

included.ShipmentItem.order_item.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included.ShipmentItem.reservations

Reservation · object[]

The locations at which inventory is reserved for this shipment item.

Show child attributes

included.ShipmentItem.reservations.location

LocationRef · object

The location from where reservation will be picked.

Show child attributes

included.ShipmentItem.reservations.location.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Location

included.ShipmentItem.reservations.location.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

42

included.ShipmentItem.reservations.quantity

number

The amount of the product to pick from the location.

included.ShipmentPackage

ShipmentPackage · object[]

Show child attributes

included.ShipmentPackage.items

object[]

A list of items contained within the ShipmentPackage.

Minimum array length: 1

Show child attributes

included.ShipmentPackage.items.sku

string

The SKU identifier for the product contained in the package.

Example:

"KDS2108"

included.ShipmentPackage.items.quantity

integer

The quantity of a particular product in a package.

Example:

2

included.ShipmentPackage.items.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.ShipmentPackage.items.order_item_sku

string

The SKU identifier for the product as it relates to the shipment in an order.

Example:

"KDS2108"

included.ShipmentPackage.items.order_item_qty

number<float>

The quantity of a product in the shipment of an order.

Example:

2

included.ShipmentPackage.items.shipment_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.ShipmentPackage.items.weight

Weight · object

The combined weight of the the same items in the package.

Show child attributes

included.ShipmentPackage.items.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.ShipmentPackage.items.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.ShipmentPackage.items.hazmat_unit_weight

Weight · object

The combined weight of the same items in thie package formatted for hazmat inspection.

Show child attributes

included.ShipmentPackage.items.hazmat_unit_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.ShipmentPackage.items.hazmat_unit_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.ShipmentPackage.items.total_customs_value

Monetary · object

The combined value of the same items in the package.

Show child attributes

included.ShipmentPackage.items.total_customs_value.amount

number<float>

This is the monetary value..

Example:

99

included.ShipmentPackage.items.total_customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.ShipmentPackage.packaging

Packaging · object[]

Packaging data to be used to process the shipment.

Show child attributes

included.ShipmentPackage.packaging.product

ProductRef · object

required

A reference to a Product object by id.

Show child attributes

included.ShipmentPackage.packaging.product.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Product

included.ShipmentPackage.packaging.product.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.ShipmentPackage.packaging.quantity

integer

required

The product quantity in the package.

Example:

4

included.ShipmentPackage.collected_data

CollectedData · object[]

Data collected for a shipment package.

Show child attributes

included.ShipmentPackage.collected_data.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.ShipmentPackage.collected_data.label

string

The label of the collected order item.

included.ShipmentPackage.collected_data.value

string

The value of the collected order item.

included.ShipmentPackage.created_at

string<date-time>

The date and time the object was created in RFC 3339 section 5.6 notation.

Example:

"2017-07-21T17:32:28Z"

included.ShipmentPackage.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.ShipmentPackageItem

PackageItem · object[]

Show child attributes

included.ShipmentPackageItem.sku

string

The SKU of the item.

included.ShipmentPackageItem.name

string

The name of the item.

included.ShipmentPackageItem.quantity

number

The number of units of this item contained in the package.

included.ShipmentPackageItem.weight

Weight · object

The combined weight of all units of this item shipped in this package.

Show child attributes

included.ShipmentPackageItem.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.ShipmentPackageItem.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.ShipmentPackageItem.hazmat_unit_weight

Weight · object

The net hazmat weight of a single units of this item. If a Net Hazmat Weight was not defined for the product at the time of shipping, this will be the product's weight for a single unit (gross weight).

Show child attributes

included.ShipmentPackageItem.hazmat_unit_weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.ShipmentPackageItem.hazmat_unit_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.ShipmentPackageItem.customs_value

Monetary · object

The combined customs value of all units of this item shipped in this package.

Show child attributes

included.ShipmentPackageItem.customs_value.amount

number<float>

This is the monetary value..

Example:

99

included.ShipmentPackageItem.customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

included.ShipmentPackageItem.order_item_id

number<int32>

A reference to the OrderItem to which this package item relates.

included.ShipmentPackageItem.order_item_sku

string

The SKU of the OrderItem to which this package item relates.

included.ShipmentPackageItem.order_item_quantity

number<float>

The number of units of the related OrderItem which this package item represents.

Beware, this number is susceptible to complex rounding issues. For example, if an order item which consists of three package items is shipped, 0.3333 + 0.3333 + 0.3333 will add up to 0.9999 rather than 1.0.

included.ShipmentPackingSolution

ShipmentPackingSolution · object[]

Show child attributes

included.ShipmentPackingSolution.type

enum<string>

Available options:

ShipmentPackingSolution

included.ShipmentPackingSolution.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.ShipmentPackingSolution.containers

ShipmentPackingSolutionContainer · object[]

The list of containers that make up the shipment's packing solution.

Show child attributes

included.ShipmentPackingSolution.containers.type

enum<string>

Available options:

ShipmentPackingSolutionContainer

included.ShipmentPackingSolution.containers.weight

Weight · object

The weight of the container when packed with the shipment items.

Show child attributes

included.ShipmentPackingSolution.containers.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.ShipmentPackingSolution.containers.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.ShipmentPackingSolution.containers.dimensions

Dimensions · object

The dimensions of the container in imperial or metric units.

Show child attributes

included.ShipmentPackingSolution.containers.dimensions.length

number<float>

This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.

Example:

8

included.ShipmentPackingSolution.containers.dimensions.width

number<float>

This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

6

included.ShipmentPackingSolution.containers.dimensions.height

number<float>

This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.

Example:

4

included.ShipmentPackingSolution.containers.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

included.ShipmentPackingSolution.containers.volume

Volume · object

The total volume of the container in imperial or metric units.

Show child attributes

included.ShipmentPackingSolution.containers.volume.value

number<float>

This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.

Example:

300

included.ShipmentPackingSolution.containers.volume.unit

enum<string>

The imperical or metric unit of measurement as a cubic value.

Available options:

in^3,

mm^3,

cm^3,

m^3

included.ShipmentPackingSolution.containers.void_percent

number<float>

The percentage of void space remaining in the container after using the packing solution to pack the items.

Example:

15.23

included.ShipmentPackingSolution.containers.regulation_type

enum<string>

The regulation type of which this container fulfills the packaging requirements.

Available options:

full,

orm-d,

limited,

small,

li-battery,

normal

included.ShipmentPackingSolution.containers.items

ShipmentPackingSolutionContainerItem · object[]

The shipment items contained within the packaging.

Minimum array length: 1

Show child attributes

included.ShipmentPackingSolution.containers.items.type

enum<string>

Available options:

ShipmentPackingSolutionContainerItem

included.ShipmentPackingSolution.containers.items.sku

string

The SKU identifier for the product packed in the container.

Example:

"KDS2108"

included.ShipmentPackingSolution.containers.items.quantity

integer

The quantity of a particular product within the packing solution's container.

Example:

2

included.ShipmentPackingSolution.containers.items.order_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.ShipmentPackingSolution.containers.items.order_item_sku

string

The product SKU associated with the container as it relates to the whole order.

Example:

"KDS2108"

included.ShipmentPackingSolution.containers.items.order_item_qty

number<float>

The quantity of a product in the container as it relates to the whole order.

Example:

2

included.ShipmentPackingSolution.containers.items.shipment_item_id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.ShipmentPackingSolution.containers.items.weight

Weight · object

The combined product weight within the container.

Show child attributes

included.ShipmentPackingSolution.containers.items.weight.value

number<float>

The weight quantity defined as a floating point value of up to 4 decimal places.

Example:

20

included.ShipmentPackingSolution.containers.items.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

included.Warehouse

Warehouse · object[]

Show child attributes

included.Warehouse.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Warehouse

included.Warehouse.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Warehouse.name

string

The display name for the Warehouse.

Maximum string length: 255

Example:

"East Coast 1"

included.Warehouse.is_active

boolean

This flag determines if the Warehouse is active and viable for fulfillment.

Example:

true

has_more

boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

string | null

The resource path for the next page of results if any are expected.

string | null

The resource path for the previous page of results if any are expected.

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Query Parameters

Response