Create Product or Packaging

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.

Body

application/json

An object conforming to the Inventory Product or PackagingFeature schema to be created.

resource

Product · object

A Product contains information about a sellable item.

Show child attributes

resource.type

enum<string>

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

Available options:

Product

resource.vendor_sku

string | null

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

Example:

"Vendor-SKU-1AD2"

resource.external_id

string | null

May be used for external product sync.

Example:

"11-993-9048"

resource.barcodes

A comma separated list of unique packaging feature barcodes.

Example:

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

resource.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

resource.is_available

enum<boolean>

default:true

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

Available options:

true,

false

resource.is_visible

enum<boolean>

default:true

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

Available options:

true,

false

resource.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

resource.lot_type.type

enum<string>

required

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

Available options:

LotType

resource.lot_type.id

integer<int64>

required

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

Example:

4

resource.weight

Weight · object

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

Show child attributes

resource.weight.value

number<float>

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

Example:

20

resource.weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

resource.dimensions

Dimensions · object

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

Show child attributes

resource.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

resource.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

resource.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

resource.dimensions.unit

enum<string>

The imperical or metric unit of measurement.

Available options:

in,

mm,

cm,

m

resource.volume

Volume · object

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

Show child attributes

resource.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

resource.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

resource.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

resource.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

resource.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

resource.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"

resource.export

Export · object

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

Show child attributes

resource.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"

resource.export.customs_value

Monetary · object

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

Show child attributes

resource.export.customs_value.amount

number<float>

This is the monetary value..

Example:

99

resource.export.customs_value.currency

string

An ISO 3166-1 alpha-3 currency code.

Example:

"USD"

resource.export.country_of_manufacture

string | null

2 letters Country ISO Code

Example:

"TW"

resource.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"

resource.export.hs_country_extension

object[] | null

Show child attributes

resource.export.hs_country_extension.country_id

string

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

resource.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" }
]

resource.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

resource.regulated_goods.regulation

Regulation · object

A reference to a Regulation by id.

Show child attributes

resource.regulated_goods.regulation.type

enum<string>

required

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

Available options:

Regulation

resource.regulated_goods.regulation.id

integer

required

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

resource.regulated_goods.technical_name

string | null

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

Example:

"Hydro Polymer Acetylene Coating"

resource.regulated_goods.additional_information

string | null

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

Example:

"Flamable Liquid"

resource.regulated_goods.net_weight

Weight · object

Show child attributes

resource.regulated_goods.net_weight.value

number<float>

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

Example:

20

resource.regulated_goods.net_weight.unit

enum<string>

This can be an imperial or metric unit for weight.

Available options:

lb,

oz,

kg,

g

resource.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"

resource.regulated_goods.container_meets_hazmat_specs

boolean

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

Example:

true

resource.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

resource.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

resource.packaging.require_packaging

enum<boolean>

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

Available options:

true,

false

Example:

true

resource.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

resource.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

resource.packaging.unit_quantity

integer | null

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

Example:

1

resource.packaging.bulk_quantity

integer | null

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

Example:

10

resource.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

resource.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

resource.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"

resource.packaging.can_tip

enum<boolean>

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

Available options:

true,

false

Example:

true

resource.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

resource.packaging.is_handling_surcharge

enum<boolean>

The Packaging Surcharge is applicable when shipped without an Overbox.

Available options:

true,

false

Example:

true

resource.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 }
]

resource.sku

string

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

Example:

"SKU-1AD"

resource.name

string

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

Example:

"Test Product"

resource.is_enabled

enum<boolean>

default:true

Disabled products are effectively deleted.

Available options:

true,

false

resource.merchant

MerchantRef · object

The Merchant to which the product belongs.

Show child attributes

resource.merchant.type

enum<string>

required

Available options:

Merchant

resource.merchant.id

integer<int32>

required

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

Example:

4

Response

Created - The resource was created successfully.

resource

object

An object describing the resource that was created.

Show child attributes

resource.type

string

A resource type identifier.

resource.id

number<int32>

The primary key ID of the resource created.

Example:

1

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Body

Response