> ## Documentation Index > Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP. > Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them. > Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately. > A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed. > List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z. > Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts. > To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com # Create Product > Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. ## OpenAPI ````yaml post /wms/products openapi: 3.1.0 info: description: > Trackstar is a Unified API that provides standard endpoints for Supply Chain Logistics. We currently offer an API for Warehouse Management Systems (WMS). title: Trackstar API version: 0.1.0 servers: - description: Trackstar API url: https://production.trackstarhq.com security: [] tags: [] externalDocs: description: Trackstar API Documentation url: https://docs.trackstarhq.com paths: /wms/products: post: tags: - wms - Products summary: Create Product description: >- Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. operationId: post_wms_create_product parameters: - in: header name: x-trackstar-api-key description: Your organization-level Trackstar API key. schema: type: string example: required: true - in: header name: x-trackstar-access-token description: >- Your user's access token for a specific integration (ShipHero, Extensiv, etc). schema: type: string example: required: true - in: header name: Idempotency-Key description: >- Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours. schema: type: string minLength: 1 maxLength: 255 example: 9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatewmsProductInputSchema' responses: '200': content: application/json: schema: $ref: '#/components/schemas/wmsCreateProductResponse' description: Successful response '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: Validation error components: schemas: CreatewmsProductInputSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/CreatewmsProduct--WMS__Sandbox--' - $ref: '#/components/schemas/CreatewmsProduct--BEST__Inc.--' - $ref: >- #/components/schemas/CreatewmsProduct--BlueBox__-_IDrive__Fulfillment_--- - $ref: '#/components/schemas/CreatewmsProduct--Boxzooka--' - $ref: '#/components/schemas/CreatewmsProduct--CartonCloud--' - $ref: >- #/components/schemas/CreatewmsProduct--J_AMP_J__Global__Fulfillment__-_Control__Port_--- - $ref: >- #/components/schemas/CreatewmsProduct--Cin7__Core__-_Dear__Systems_--- - $ref: '#/components/schemas/CreatewmsProduct--Deposco--' - $ref: '#/components/schemas/CreatewmsProduct--Extensiv__-_3PL__Central_---' - $ref: '#/components/schemas/CreatewmsProduct--Flexport__-_Deliverr_---' - $ref: '#/components/schemas/CreatewmsProduct--I-Fulfilment--' - $ref: '#/components/schemas/CreatewmsProduct--Infoplus--' - $ref: '#/components/schemas/CreatewmsProduct--Cart.com__-_Jazz__Central_---' - $ref: '#/components/schemas/CreatewmsProduct--Linnworks--' - $ref: '#/components/schemas/CreatewmsProduct--Quickbox__-_LogicPod_---' - $ref: '#/components/schemas/CreatewmsProduct--Logiwa__IO--' - $ref: '#/components/schemas/CreatewmsProduct--Luminous--' - $ref: '#/components/schemas/CreatewmsProduct--MasonHub--' - $ref: '#/components/schemas/CreatewmsProduct--Moda__Express--' - $ref: '#/components/schemas/CreatewmsProduct--NextSmartShip--' - $ref: '#/components/schemas/CreatewmsProduct--Nimble--' - $ref: '#/components/schemas/CreatewmsProduct--NPFulfilment--' - $ref: '#/components/schemas/CreatewmsProduct--Ongoing__WMS--' - $ref: '#/components/schemas/CreatewmsProduct--Portless--' - $ref: '#/components/schemas/CreatewmsProduct--ShipBob--' - $ref: '#/components/schemas/CreatewmsProduct--Shipedge--' - $ref: '#/components/schemas/CreatewmsProduct--Shipfusion--' - $ref: '#/components/schemas/CreatewmsProduct--ShipHero--' - $ref: '#/components/schemas/CreatewmsProduct--ShipMonk--' - $ref: '#/components/schemas/CreatewmsProduct--ShipStream--' - $ref: '#/components/schemas/CreatewmsProduct--Shipwire--' - $ref: '#/components/schemas/CreatewmsProduct--SKUSavvy--' - $ref: >- #/components/schemas/CreatewmsProduct--Linnworks__Core__-_SKUVault_--- - $ref: '#/components/schemas/CreatewmsProduct--Star__WMS--' - $ref: '#/components/schemas/CreatewmsProduct--TLogistics--' - $ref: '#/components/schemas/CreatewmsProduct--Unleashed--' - $ref: '#/components/schemas/CreatewmsProduct--VeraCore--' - $ref: '#/components/schemas/CreatewmsProduct--Warehance--' - $ref: '#/components/schemas/CreatewmsProduct--Whiplash__-_Ryder_---' title: CreatewmsProductInputSchema wmsCreateProductResponse: type: object properties: data: $ref: '#/components/schemas/WmsProductApiItemSchema' id: type: string description: The ID of the object that has been created or modified example: id unused_fields: type: array description: Unused fields items: type: string description: '' example: unused_fields required: - id - unused_fields additionalProperties: false title: wmsCreateProductResponse ValidationError: properties: error: type: string detail: type: object properties: : type: object properties: : type: array items: type: string required: - error type: object title: ValidationError CreatewmsProduct--WMS__Sandbox--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: XS-RED-SHIRT name: type: string description: name example: XS Red Shirt gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: '012345678905' measurements: $ref: '#/components/schemas/ProductMeasurements' required: - name - sku additionalProperties: false title: WMS Sandbox CreatewmsProduct--BEST__Inc.--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin unit_price: type: number description: The price of the product. example: 10.99 country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' measurements: $ref: '#/components/schemas/ProductMeasurementsbest-inc' required: - measurements - name - sku additionalProperties: false title: BEST Inc. CreatewmsProduct--BlueBox__-_IDrive__Fulfillment_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string description: name example: name sku: type: string description: sku example: sku gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurementsbluebox' price: type: number description: Price of the product example: 0 required: - gtin - name - sku additionalProperties: false title: BlueBox (IDrive Fulfillment) CreatewmsProduct--Boxzooka--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementsboxzooka' - type: 'null' unit_price: type: number description: The price of the product. example: 10.99 country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' required: - name - sku additionalProperties: false title: Boxzooka CreatewmsProduct--CartonCloud--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id type: type: string description: Product type defined per tenant (e.g. 'FROZEN', 'DRY GOODS') example: type barcode: type: string description: Product barcode example: barcode description: type: string description: Full product description example: description length: type: number description: Product length example: 0 width: type: number description: Product width example: 0 height: type: number description: Product height example: 0 country_of_origin: type: string description: Country of origin example: country_of_origin required: - name - sku - type additionalProperties: false title: CartonCloud CreatewmsProduct--J_AMP_J__Global__Fulfillment__-_Control__Port_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin unit_price: type: number description: The price of the product. example: 10.99 country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' customs_description: type: string description: Customs description matching the harmonized code. example: Perfumes and toilet waters cost: type: number description: The production cost price of the product. example: 30.5 required: - cost - country_of_origin - customs_description - harmonized_code - name - sku - unit_price additionalProperties: false title: J&J Global Fulfillment (Control Port) CreatewmsProduct--Cin7__Core__-_Dear__Systems_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string description: name example: name sku: type: string description: sku example: sku measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementsdear-systems' - type: 'null' costing_method: type: string enum: - FIFO - Special - Batch - Special - Serial Number - FIFO - Serial Number - FIFO - Batch - FEFO - Batch - FEFO - Serial Number description: Costing method for the product. example: FEFO - Batch gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin required: - costing_method - gtin - name - sku additionalProperties: false title: Cin7 Core (Dear Systems) CreatewmsProduct--Deposco--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string description: name example: name sku: type: string description: sku example: sku gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementsdeposco' - type: 'null' active: type: boolean default: true description: Whether the product is active, defaults to True. example: true required: - name - sku additionalProperties: false title: Deposco CreatewmsProduct--Extensiv__-_3PL__Central_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string description: name example: name sku: type: string description: sku example: sku gtin: type: - string - 'null' description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id required: - name - sku additionalProperties: false title: Extensiv (3PL Central) CreatewmsProduct--Flexport__-_Deliverr_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string maxLength: 255 description: name example: name sku: type: string maxLength: 255 description: sku example: sku measurements: $ref: '#/components/schemas/ProductMeasurementsflexport' country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string pattern: ^[0-9]{10}$ description: The harmonized HS code of the product. example: '0101210000' customs_value: type: number description: >- The customs value of the product in USD. Required when providing customs information. example: 0 customs_description: type: string maxLength: 255 description: >- The customs description of the product. Required when providing customs information. example: customs_description required: - name - sku additionalProperties: false title: Flexport (Deliverr) CreatewmsProduct--I-Fulfilment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string pattern: ^\d{3,20}$ description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: '012345678905' brand_id: type: string enum: - N/A - Connect an account to see options description: The brand for the product. example: brand_id channel_id: type: string enum: - N/A - Connect an account to see options description: The channel for the product. example: channel_id measurements: $ref: '#/components/schemas/ProductMeasurementsi-fulfilment' quantity: type: integer default: 1 description: DOQ quantity. example: 0 shippable: type: boolean default: true description: Whether this DOQ is shippable. example: true perishable: type: boolean default: false description: Whether the product is perishable. example: true organic: type: boolean default: false description: Whether the product is organic. example: true dangerous: type: boolean default: false description: Whether the product is dangerous. example: true dutiable: type: boolean default: false description: Whether the product is dutiable. example: true hygiene: type: boolean default: false description: Whether the product is for hygiene. example: true battery: type: boolean default: false description: Whether the product contains a battery. example: true fragile: type: boolean default: false description: Whether the product is fragile. example: true what_is_it: type: string description: A description of what the product is. example: what_is_it made_of: type: string description: What the product is made of. example: made_of used_for: type: string description: What the product is used for. example: used_for country_of_origin: type: string default: US description: The country of origin of the product. example: USA customs_code_id: type: integer description: The ID of the customs code for the product. example: 0 required: - brand_id - channel_id - customs_code_id - gtin - made_of - measurements - name - sku - used_for - what_is_it additionalProperties: false title: I-Fulfilment CreatewmsProduct--Infoplus--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku warehouse_customer_id: type: string description: ID of the warehouse customer that owns this product example: warehouse_customer_id name: type: string description: name example: name status: type: string enum: - Active - Deplete - Blocked - Placeholder - Outside Vendor - Print on Demand description: Status of the product example: Active lot_mixing_rule: type: string default: SKU enum: - Item Receipt - Inventory Properties - SKU description: >- Controls how an item can be mixed in a lot. (e.g. items in a location all have to have come from the same production lot, items in a location have to have the same SKU but can have different inventory properties). example: SKU item_mixing_rule: type: string default: Single enum: - Single - Multi description: Controls if items can be mixed with other items in a location. example: Single allocation_rule: type: string default: Strict enum: - Strict - Weak - Labor Optimized description: >- Rule for allocating inventory to orders. Strict and Weak require a lot mixing rule of Item Receipt example: Strict backorder: type: boolean default: false description: Backorders created for this item when it is out of stock example: true major_group_id: type: integer description: ID of the major group this item belongs to. Must exist in Infoplus example: 0 subgroup_id: type: integer description: ID of the subgroup this item belongs to. Must exist in Infoplus example: 0 hazmat: type: boolean default: false description: Whether this item is hazardous example: true secure: type: boolean default: false description: Control if item must be stored in a secure warehouse example: true seasonal_item: type: boolean default: false description: >- Whether this item expereinces significant differences in usage based on time of year example: true receiving_criteria_scheme_id: type: integer description: >- ID of the receiving criteria scheme this item belongs to. Must exist in Infoplus example: 0 gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurementsinfoplus' price: type: number description: Price of the product example: 0 required: - major_group_id - name - receiving_criteria_scheme_id - sku - status - subgroup_id - warehouse_customer_id additionalProperties: false title: Infoplus CreatewmsProduct--Cart.com__-_Jazz__Central_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin price: type: number description: The price of the product. example: 1 required: - gtin - price - sku additionalProperties: false title: Cart.com (Jazz Central) CreatewmsProduct--Linnworks--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin unit_price: type: number description: The price of the product. example: 10.99 extended_properties: type: array description: Custom properties to attach to the product example: - name: Color value: Red type: Attribute items: $ref: '#/components/schemas/ExtendedPropertySchema' measurements: $ref: '#/components/schemas/ProductMeasurementslinnworks' required: - name - sku additionalProperties: false title: Linnworks CreatewmsProduct--Quickbox__-_LogicPod_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' unit_price: type: number description: The price of the product. example: 10.99 measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementslogicpod' - type: 'null' required: - name - sku additionalProperties: false title: Quickbox (LogicPod) CreatewmsProduct--Logiwa__IO--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id sku: type: string description: sku example: sku name: type: string description: name example: name description: type: string description: '' example: description gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin required: - description - name - sku - warehouse_customer_id additionalProperties: false title: Logiwa IO CreatewmsProduct--Luminous--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurementsluminous' category_id: type: integer minimum: 1 description: The ID of the Luminous category the product belongs to. example: 1 required: - category_id - name - sku additionalProperties: false title: Luminous CreatewmsProduct--MasonHub--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name measurements: $ref: '#/components/schemas/ProductMeasurementsmasonhub' gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin description: type: string description: Description of the product. example: description customer_bar_code: type: string description: Customer provided bar code for this sku. example: customer_bar_code brand_name: type: string description: Brand name for this sku and product. example: brand_name category: type: string description: Product category for this sku. example: category sub_category: type: string description: Product sub category for this sku. example: sub_category vendor_brand_code: type: string description: Vendor provided brand code for identifying this sku. example: vendor_brand_code customer_brand_code: type: string description: >- Customer provided brand code for identifying this sku. Used on packing lists. example: customer_brand_code vendor_style: type: string description: Vendor style code for item identification. example: vendor_style required: - brand_name - category - customer_bar_code - customer_brand_code - description - measurements - name - sku - sub_category - vendor_brand_code - vendor_style additionalProperties: false title: MasonHub CreatewmsProduct--Moda__Express--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string maxLength: 128 description: sku example: sku name: type: string maxLength: 128 description: name example: name gtin: type: string maxLength: 512 description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurements' active: type: boolean description: Whether the product is active. example: true unit_price: type: number minimum: 0 description: The price of the product. example: 10.99 required: - gtin - measurements - name - sku additionalProperties: false title: Moda Express CreatewmsProduct--NextSmartShip--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementsnextsmartship' - type: 'null' attribute: type: string enum: - GENERAL_CARGO - BATTERY_INCLUDED - BATTERY_ONLY - MAGNETIC - SPECIAL description: >- NextSmartShip cargo classification, used for shipping and customs compliance. example: GENERAL_CARGO packaging: type: string enum: - pre-packaged - sales-packaged - bare-packaged description: Physical packaging state the product arrives at the warehouse in. example: pre-packaged customs: $ref: '#/components/schemas/NextsmartshipProductCustoms' sales_url: type: string description: Public storefront URL for the product. example: https://shop.example.com/products/abc-001 images: type: array description: Product image URLs. example: - https://cdn.example.com/abc-001.jpg items: type: string description: '' example: images required: - attribute - customs - harmonized_code - name - packaging - sku additionalProperties: false title: NextSmartShip CreatewmsProduct--Nimble--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: Required. example: '123456789' vendor_sku: type: string description: An external vendor SKU example: '123456789' description: type: string description: Description of the product example: Description gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin name: type: string description: name example: name measurements: $ref: '#/components/schemas/NimbleProductMeasurements' required: - description - gtin - measurements additionalProperties: false title: Nimble CreatewmsProduct--NPFulfilment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string maxLength: 30 description: sku example: sku name: type: string maxLength: 100 description: name example: name gtin: type: string maxLength: 50 description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurements' country_of_origin: type: string maxLength: 50 description: The country of origin of the product. example: USA harmonized_code: type: string maxLength: 50 description: The harmonized HS code of the product. example: '123456' unit_price: type: number minimum: 0 description: The price of the product. example: 10.99 required: - gtin - measurements - name - sku additionalProperties: false title: NPFulfilment CreatewmsProduct--Ongoing__WMS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin required: - gtin - name - sku additionalProperties: false title: Ongoing WMS CreatewmsProduct--Portless--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string description: name example: name sku: type: string description: sku example: sku gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' measurements: $ref: '#/components/schemas/ProductMeasurementsportless' required: - name - sku additionalProperties: false title: Portless CreatewmsProduct--ShipBob--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurementsshipbob' country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' barcodes: type: array description: Barcodes to scan the product by example: - '012345678905' items: type: string description: Barcode example: '012345678905' is_lot: type: boolean description: Whether shipbob tracks the product by lot example: true minimum_shelf_life_days: type: integer minimum: 0 description: >- Days of shelf life a lot must have left for shipbob to ship it. Shipbob only accepts this when is_lot is true. example: 30 packaging_requirement: type: string description: >- How the product must be packed. Any shipbob packaging requirement name, e.g. 'No Requirements', 'Fragile', 'Foldable', 'Media', 'Book', 'Poster', 'Apparel', 'Packaging Material', 'Ships In Own Container'. example: Foldable packaging_material: type: string description: >- What the product is packed in. Any shipbob packaging material name, e.g. 'Box', 'Bubble Mailer', 'Poly Mailer', 'Poster Tube', 'Custom Box', 'Bookfold', 'Ship In Own Container', 'Custom Bubble Mailer', 'Custom Poly Mailer'. Shipbob only allows certain materials with each requirement. example: Custom Poly Mailer return_preference_primary_action: type: string enum: - Restock - Quarantine - Dispose description: >- What shipbob should do with the product when it is returned. Shipbob rejects Restock on a lot product. example: Restock return_preference_backup_action: type: string enum: - Restock - Quarantine - Dispose description: >- What shipbob should do with the returned product when the primary action is not possible. Shipbob only accepts a backup action when the primary one is Restock. example: Dispose return_to_sender_primary_action: type: string enum: - Restock - Quarantine - Dispose description: >- What shipbob should do with the product when a shipment is returned to sender. Shipbob rejects Restock on a lot product. example: Restock return_to_sender_backup_action: type: string enum: - Restock - Quarantine - Dispose description: >- What shipbob should do with a product returned to sender when the primary action is not possible. Shipbob only accepts a backup action when the primary one is Restock. example: Quarantine required: - name - sku additionalProperties: false title: ShipBob CreatewmsProduct--Shipedge--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name unit_price: type: number description: The price of the product. example: 10.99 measurements: $ref: '#/components/schemas/ProductMeasurements' gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' supplier_object: $ref: '#/components/schemas/SupplierSchema' description: The supplier of the product. required: - measurements - name - sku - unit_price additionalProperties: false title: Shipedge CreatewmsProduct--Shipfusion--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementsshipfusion' - type: 'null' price: type: number description: The retail price of the product example: 0 required: - name - sku additionalProperties: false title: Shipfusion CreatewmsProduct--ShipHero--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin warehouse_id: type: string description: >- Warehouse ID where the product is stored. ShipHero creates a WarehouseProduct here alongside the new general Product. Use warehouse_ids to seed several warehouses in one call. example: warehouse_id warehouse_ids: type: array description: >- Warehouse IDs to seed the product into (one WarehouseProduct each, 0 on hand). Use instead of warehouse_id to create the product in multiple warehouses in a single call. example: - warehouse_id_1 - warehouse_id_2 items: type: string description: '' example: warehouse_ids measurements: $ref: '#/components/schemas/ProductMeasurementsshiphero' required: - name - sku additionalProperties: false title: ShipHero CreatewmsProduct--ShipMonk--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin required_packaging: type: string enum: - poly_mailer - bubble_mailer - box - slap_a_label - custom description: Required level of packaging for the product. example: box fragile: type: boolean description: '' example: true measurements: $ref: '#/components/schemas/ProductMeasurementsshipmonk' replacement_cost: type: number description: '' example: 0 customs_declaration_value: type: number description: '' example: 0 country_of_origin: type: string description: ISO 3166-1 alpha-2 country code. i.e. US example: country_of_origin required: - country_of_origin - customs_declaration_value - fragile - gtin - measurements - name - replacement_cost - required_packaging - sku additionalProperties: false title: ShipMonk CreatewmsProduct--ShipStream--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurementsshipstream' required: - measurements - name - sku additionalProperties: false title: ShipStream CreatewmsProduct--Shipwire--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string minLength: 1 maxLength: 26 description: sku example: sku category: type: string default: OTHER enum: - OTHER - APPAREL - TOYS_SPORTS_HOBBIES description: The product category example: OTHER name: type: string description: name example: name gtin: type: string minLength: 12 maxLength: 12 description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: '012345678905' measurements: $ref: '#/components/schemas/ProductMeasurementsshipwire' cost_value: type: number description: The cost of the product example: 0 retail_value: type: number description: The retail value of the product example: 0 battery_configuration: type: string default: NOBATTERY enum: - NOBATTERY - ISBATTERY - HASBATTERY - HASLOOSEBATTERY description: The battery configuration of the product example: NOBATTERY required: - cost_value - measurements - name - retail_value - sku additionalProperties: false title: Shipwire CreatewmsProduct--SKUSavvy--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name measurements: $ref: '#/components/schemas/ProductMeasurementsskusavvy' price: type: number description: Price of the product example: 0 gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin required: - gtin - measurements - name - price - sku additionalProperties: false title: SKUSavvy CreatewmsProduct--Linnworks__Core__-_SKUVault_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name classification: type: string description: Classification of the product. Defaults to 'General' example: classification supplier_object: $ref: '#/components/schemas/SupplierSchema' description: The supplier of the product. brand: type: string description: Brand name. Defaults to 'Generic' example: brand measurements: $ref: '#/components/schemas/ProductMeasurementsskuvault' gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id required: - measurements - sku additionalProperties: false title: Linnworks Core (SKUVault) CreatewmsProduct--Star__WMS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin unit_price: type: number description: The price of the product. example: 10.99 country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' declared_name_cn: type: string description: Customs declared name of the product, in Chinese. example: 测试产品 declared_name_en: type: string description: Customs declared name of the product, in English. example: Test Product measurements: $ref: '#/components/schemas/ProductMeasurements' dangerous_cargo: type: integer minimum: 1 maximum: 8 description: Hazmat classification of the product. 1 = normal/non-hazardous. example: 1 required: - country_of_origin - dangerous_cargo - declared_name_cn - declared_name_en - gtin - harmonized_code - measurements - name - sku - unit_price additionalProperties: false title: Star WMS CreatewmsProduct--TLogistics--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string maxLength: 50 description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin country_of_origin: type: string description: The country of origin of the product. example: USA harmonized_code: type: string description: The harmonized HS code of the product. example: '123456' measurements: anyOf: - $ref: '#/components/schemas/ProductMeasurementstlogistics' - type: 'null' batch_required: type: boolean enum: - true description: >- Whether tlogistics registers a batch code for the product when it is received. Only true is accepted. example: true expiry_required: type: boolean description: >- Whether tlogistics registers an expiry date for the product when it is received example: true required: - name - sku additionalProperties: false title: TLogistics CreatewmsProduct--Unleashed--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin measurements: $ref: '#/components/schemas/ProductMeasurementsunleashed' required: - name - sku additionalProperties: false title: Unleashed CreatewmsProduct--VeraCore--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} name: type: string description: name example: name sku: type: string description: sku example: sku client_id: type: string enum: - N/A - Connect an account to see options description: The owner of the product. example: client_id product_type: type: string default: Regular enum: - Regular - Regular Valuable - Bulky Valuable - Requires Safe - Refrigerated - Food - Pharmaceutical - Ink - Hazardous Material - Fragile - Frozen - OTC Medications - Clean - Medical - Special Handling description: '' example: Regular required: - client_id - name - sku additionalProperties: false title: VeraCore CreatewmsProduct--Warehance--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: name example: name warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id unit_price: type: number description: The price of the product. example: 10.99 gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin weight: type: number description: Weight in ounces (oz). example: 8 length: type: number description: Length in inches (in). example: 10 width: type: number description: Width in inches (in). example: 5 height: type: number description: Height in inches (in). example: 3 required: - name - sku - warehouse_customer_id additionalProperties: false title: Warehance CreatewmsProduct--Whiplash__-_Ryder_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} sku: type: string description: sku example: sku name: type: string description: '' example: name gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin required: - gtin - sku additionalProperties: false title: Whiplash (Ryder) WmsProductApiItemSchema: type: object properties: id: type: string description: The unique ID of the product. example: product_id warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id created_date: type: string format: date-time description: The date the product was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the product was last updated. example: '2022-01-02T05:05:05Z' name: type: string description: name example: name sku: type: - string - 'null' description: sku example: sku gtin: type: - string - 'null' description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin unit_price: type: - number - 'null' description: The price of the product. example: 10.99 inventory_items: type: array description: A list of inventory items associated with the product. example: - inventory_item_id: id1 sku: sku1 unit_quantity: 1 - inventory_item_id: id2 sku: sku2 unit_quantity: 1 items: $ref: '#/components/schemas/ProductInventoryItems' is_kit: type: boolean description: '' example: true active: type: boolean description: Whether the product is active. example: true supplier_object: anyOf: - $ref: '#/components/schemas/ProductSupplier' - type: 'null' country_of_origin: type: - string - 'null' description: The country of origin of the product. example: USA harmonized_code: type: - string - 'null' description: The harmonized HS code of the product. example: '123456' supplier_products: type: array description: A list of supplier products associated with the product. example: - supplier_id: id1 supplier_name: name1 external_id: ext_id1 unit_cost: 1 - supplier_id: id2 supplier_name: name2 external_id: ext_id2 unit_cost: 2.5 items: $ref: '#/components/schemas/ProductSupplierProducts' categories: type: array description: A list of category names associated with the product. example: - Electronics - Accessories items: type: string description: '' example: categories image_urls: type: array description: A list of image URLs associated with the product. example: - https://example.com/image1.jpg items: type: string description: '' example: image_urls external_system_url: type: - string - 'null' description: URL link to the product in the external system (WMS/Freight etc). example: https://example.com/product/123 trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} additional_fields: type: object description: Integration-specific fields example: key: value additionalProperties: {} trackstar_created_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' trackstar_updated_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' required: - active - additional_fields - categories - country_of_origin - created_date - external_system_url - gtin - harmonized_code - id - image_urls - inventory_items - is_kit - name - sku - supplier_object - supplier_products - trackstar_created_date - trackstar_tags - trackstar_updated_date - unit_price - updated_date - warehouse_customer_id additionalProperties: false title: WmsProductApiItemSchema ProductMeasurements: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurements ProductMeasurementsbest-inc: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsbest-inc ProductMeasurementsbluebox: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsbluebox ProductMeasurementsboxzooka: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsboxzooka ProductMeasurementsdear-systems: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsdear-systems ProductMeasurementsdeposco: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsdeposco ProductMeasurementsflexport: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsflexport ProductMeasurementsi-fulfilment: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsi-fulfilment ProductMeasurementsinfoplus: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsinfoplus ExtendedPropertySchema: type: object properties: name: type: string description: Property name example: name value: type: string description: Property value example: value type: type: string enum: - Attribute - Channel - Compatibility - Condition - Fulfilment SKU - Other - Shipping - StockItem Label description: Property type example: Attribute required: - name - type - value additionalProperties: false title: ExtendedPropertySchema ProductMeasurementslinnworks: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementslinnworks ProductMeasurementslogicpod: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementslogicpod ProductMeasurementsluminous: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsluminous ProductMeasurementsmasonhub: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsmasonhub ProductMeasurementsnextsmartship: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsnextsmartship NextsmartshipProductCustoms: type: object properties: name_en: type: string description: English product name for the customs declaration. example: Cotton T-Shirt name_zh: type: string description: Chinese product name for the customs declaration. example: 棉质T恤 purpose: type: string description: The product's end use, for customs. example: Apparel material: type: string description: The product's primary material, for customs. example: Cotton declared_values: type: array description: >- Declared customs value of the product, one entry per destination country plus an OTHER catch-all. example: - country: US amount: 8 currency: USD items: $ref: '#/components/schemas/NextsmartshipProductDeclaredValue' required: - declared_values - name_en - name_zh additionalProperties: false title: NextsmartshipProductCustoms NimbleProductMeasurements: type: object properties: length: type: number description: Length of the product. example: 1 width: type: number description: Width of the product. example: 1 height: type: number description: Height of the product. example: 1 weight: type: number description: Weight of the product. example: 1 unit: type: string enum: - cm - in description: The unit of measurement for the size of the product. example: in weight_unit: type: string enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - unit - weight_unit additionalProperties: false title: NimbleProductMeasurements ProductMeasurementsportless: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsportless ProductMeasurementsshipbob: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsshipbob SupplierSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/SupplierId' - $ref: '#/components/schemas/SupplierName' discriminator: propertyName: type mapping: id: '#/components/schemas/SupplierId' name: '#/components/schemas/SupplierName' title: SupplierSchema ProductMeasurementsshipfusion: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsshipfusion ProductMeasurementsshiphero: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsshiphero ProductMeasurementsshipmonk: type: object properties: weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - weight - weight_unit additionalProperties: false title: ProductMeasurementsshipmonk ProductMeasurementsshipstream: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsshipstream ProductMeasurementsshipwire: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 weight: type: - number - 'null' description: '' example: 2.5 units: type: string default: US enum: - US - METRIC description: >- The unit of measurement. If US, inches and pounds. If Metric, cm and kgs. example: US required: - height - length - weight - width additionalProperties: false title: ProductMeasurementsshipwire ProductMeasurementsskusavvy: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsskusavvy ProductMeasurementsskuvault: type: object properties: weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - weight - weight_unit additionalProperties: false title: ProductMeasurementsskuvault ProductMeasurementstlogistics: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementstlogistics ProductMeasurementsunleashed: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the product. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the product. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ProductMeasurementsunleashed ProductInventoryItems: type: object properties: inventory_item_id: type: string description: >- ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: inv_id sku: type: - string - 'null' description: '' example: sku unit_quantity: type: integer description: The number of units of the inventory item in the product. example: 0 required: - inventory_item_id - sku - unit_quantity additionalProperties: false title: ProductInventoryItems ProductSupplier: type: object properties: supplier_id: type: string description: The ID of the supplier. example: supplier_id supplier_name: type: - string - 'null' description: The name of the supplier. example: supplier_name required: - supplier_id - supplier_name additionalProperties: false title: ProductSupplier ProductSupplierProducts: type: object properties: supplier_id: type: string description: ID of the supplier. example: sup_id supplier_name: type: - string - 'null' description: Name of the supplier. example: sup_name external_id: type: - string - 'null' description: The external ID of the product from the supplier. example: ext_id unit_cost: type: - string - 'null' description: The cost of the product from the supplier. example: unit_cost required: - external_id - supplier_id - supplier_name - unit_cost additionalProperties: false title: ProductSupplierProducts NextsmartshipProductDeclaredValue: type: object properties: country: type: string description: Destination country code, or OTHER for the rest-of-world value. example: US amount: type: number description: Declared customs value. example: 8 currency: type: string enum: - USD description: ISO 4217 currency code. example: USD required: - amount - country - currency additionalProperties: false title: NextsmartshipProductDeclaredValue SupplierId: type: object properties: supplier_id: type: string description: The ID of the supplier. example: supplier_id required: - supplier_id additionalProperties: false title: SupplierId SupplierName: type: object properties: supplier_name: type: string description: The name of the supplier. example: supplier_name required: - supplier_name additionalProperties: false title: SupplierName ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.