Items

Models

Item Model

The item model represents a unique item for which you would like to track the quantity.

object "item"
The enum value identifying this as an item model.

alternate_names string[]
A list of alternate names for this item. Always present, defaulting to an empty array. Items are searchable by their alternate names. Stored sorted and deduplicated, with up to 10 entries.

alternate_product_numbers string[]
A list of alternate product numbers for this item. Always present, defaulting to an empty array. Items are searchable by their alternate product numbers. Stored sorted and deduplicated, with up to 10 entries.

attributes Array.<string>
A list of enumerated strings to give more context to special items. For example: alcohol, marijuana, pharma, dry_ice, lithium

color string
Any value can be added here

created_at integer
Time in epoch seconds when this resource was created

description string
The details about the item

gtin string
The global identifier for the item, which is consistent across vendors for this item

harmonized_code string
The harmonized system code for the item. This is required if you will be shipping this item internationally.

id string
The unique ID given to this product. This will stay the same even if the SKU or GTIN values are updated.

external_id string
An external identifier for this item, useful for linking with third-party systems or integrations.

vendor string
The name of the vendor or supplier for this item.

images Array.<object>
A list of image objects that have been added for this item. Each object contains name (the image file name), url (the image URL), and is_public (boolean indicating if the image is publicly accessible).

image_urls Array.<string>
A flat array of image URLs for this item. This is a convenience field that provides direct access to all image URLs without needing to extract them from the images objects.

levels Array.<InventoryLevel>
Information about inventory levels for this item across various locations and layouts

Show Details


InventoryLevel.object `"level"` The enum for this object
InventoryLevel.id `string` The ID for the level, prefixed with `lvl_`
InventoryLevel.location_id `string` The ID of the location in which this inventory level is housed
InventoryLevel.location_name `string` The display name of the location
InventoryLevel.layout_id `string` The layout ID within the location where this inventory can be found
InventoryLevel.layout_name `string` The full nested path of the layout bin (e.g., `Aisle A > Shelf B > Bin 3`). Updated automatically if the layout is renamed. Also returned as `layout_nested_name`.
InventoryLevel.layout_code `string` The short code of the layout bin
InventoryLevel.available_qty `float` The amount of on-hand inventory available for use. Supports fractional quantities up to 4 decimal places.
InventoryLevel.defective_qty `float` The amount of on-hand inventory that is deemed defective or damaged. Supports fractional quantities up to 4 decimal places.
InventoryLevel.verified_qty `float` (deprecated) Alias for `available_qty`. Use `available_qty` instead.
InventoryLevel.damaged_qty `float` (deprecated) Alias for `defective_qty`. Use `defective_qty` instead.
InventoryLevel.manifested_qty `integer` The amount of inventory that is on a manifest that has not been added to inventory yet
InventoryLevel.reserved_qty `integer` Inventory reserved for a fulfillment, pulled out of the `available_qty` count
InventoryLevel.stored_qty `integer` Number of assets at this level with the status `in_storage`
InventoryLevel.operational_qty `integer` Number of assets at this level with the status `in_use` or `on_loan`
InventoryLevel.processing_qty `integer` Number of assets at this level with the status `in_pipeline`, `in_transit`, `in_repair`, or `for_sale`
InventoryLevel.decommissioned_qty `integer` Number of assets at this level with the status `donated`, `lost`, `stolen`, `disposed`, `out_of_service`, `missing`, or `sold`
InventoryLevel.updated_at `integer` Time in epoch seconds when this level was last updated
InventoryLevel.updated_by `string` The ID of the user or API key that last updated this level

_documents EmbeddedDocument[] | null
An array of the documents linked to this item. Only populated when the retrieve endpoint is called with include_documents=true; otherwise it is null. Each entry is an EmbeddedDocument - a subset of the standard Document object that omits linkages, _upload_url, and the top-level checksum. The file.url is the unsigned public path and is not a signed URL, so private documents are listed but their url is not a working download link.

Show Details


EmbeddedDocument.id `string` The unique ID of the document, prefixed with `doc_`
EmbeddedDocument.object `"document"` The enum value identifying this as a document
EmbeddedDocument.organization_id `string` The ID of the organization that owns the document
EmbeddedDocument.file `object` The file details: `name` (string), `url` (string, unsigned public path), `checksum` (string), `size` (string, bytes), and `mime_type` (string)
EmbeddedDocument.visibility `string` The visibility of the document, either `public` or `private`
EmbeddedDocument.status `string` The processing status of the document (e.g. `pending`, `completed`)
EmbeddedDocument.category `string` The category of the document
EmbeddedDocument.metadata `object` The metadata key value pairs added to the document
EmbeddedDocument.created_by `string` The ID of the user or API key that created the document
EmbeddedDocument.create_by_details `object` The `id` and `name` of the creator
EmbeddedDocument.created_at `integer` Time in epoch seconds when the document was created
EmbeddedDocument.updated_at `integer` Time in epoch seconds when the document was last updated
EmbeddedDocument.deleted_at `integer` \| `null` Time in epoch seconds when the document was deleted, or `null`

metadata object
These are your metadata key value pairs added to the item

name string
The name of the item

length float
The length of the item in inches

width float The width of the item in inches

height float
The height of the item in inches

weight float
The weight of the item in pounds (lbs)

packaged_length float
The length of the item in inches once packaged for shipping. For example, a mobile phone often ships in a box with some cables and reading materials inside. Packaged length would be the length of the box that the mobile phone is housed in.

packaged_width float
The width of the item in inches when placed in shipping packaging

packaged_height float
The height of the item in inches when placed in shipping packaging

packaged_weight float
The weight of the item in pounds (lbs) when placed in shipping packaging

origin_country string
The country that manufactured this item. This is required if shipping the item internationally

organization_id string
The unique identifier for the organization that owns this item. This will always be your organization ID

size string
The size of the item. This is used for display purposes on a product page. This is common when adding something like a "small" or "large" variation.

sku string
The SKU of the item added by you

upc string
The Universal Product Code of the item

total_available float
The total available inventory count across all levels. This is the replacement for the deprecated total_verified field.

total_verified float (deprecated)
The total verified inventory count across all levels. Deprecated: use total_available instead.

total_defective float
The total defective inventory count across all levels. This is the replacement for the deprecated total_damaged field.

total_damaged float (deprecated)
The total damaged inventory count across all levels. Deprecated: use total_defective instead.

total_manifested integer
The total inventory count that is on a manifest

total_reserved integer
The total inventory count that is reserved

total_stored integer
The total asset inventory marked as in_storage

total_operational integer
The total asset inventory marked as in_use or on_loan

total_processing integer
The total asset inventory marked as in_pipeline, in_transit, in_repair, or for_sale

total_decommissioned integer
The total asset inventory marked as donated, lost, stolen, disposed, out_of_service, missing, or sold

updated_at integer
Time in epoch seconds when this resource was updated

created_by string
The ID of the user or API key that created this item

updated_by string
The ID of the user or API key that last updated this item

checksum string
An MD5 checksum of the item's properties. This value changes whenever the item is modified, making it useful for detecting changes without comparing individual fields.

value integer
The value of each individual item in cents

last_audited_at date
Timestamp of the last audit date for this item's inventory.

is_asset boolean
Indicates whether the item is an asset.

ship_ready boolean
Indicates whether the item is ready to ship directly.

tariff_codes array
Array of country specific tariff codes. Each entry in the array contains the country and code keys, representing the country and the tariff code respectively.

external_type string
A classification or type label for the external system linked via external_id. Useful for distinguishing between different integration sources.

base_uom string
The base unit of measure for this item. Defaults to "unit". Other possible values depend on the configured UOM units (e.g., "kg", "lb", "box").

uom_category string
The unit-of-measure category derived from the base_uom. Defaults to "count".

transactional_units Array.<object>
The list of transactional units defined for this item, including the base unit. Each entry specifies an alternative unit of measure and how many base units it represents.

Show Details


TransactionalUnit.id `string` The unique ID of the transactional unit, prefixed with `itu_`
TransactionalUnit.name `string` The name of the unit (e.g., `"Box"`, `"Pallet"`)
TransactionalUnit.conversion_factor `float` The number of base units equivalent to one unit of this measure

Models

# Item Model

Item Model