Product created

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

ProductSchema · object

required

Show child attributes

data.id

string

The unique ID of the product.

Example:

"product_id"

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the product. Can be passed into the Warehouse Customer endpoint for more details.

Example:

"warehouse_customer_id"

data.created_date

string<date-time>

The date the product was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the product was last updated.

Example:

"2022-01-02T05:05:05Z"

data.name

string

name

Example:

"name"

data.sku

string | null

sku

Example:

"sku"

data.gtin

string | null

The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.

Example:

"gtin"

data.unit_price

number | null

The price of the product.

Example:

10.99

data.inventory_items

ProductInventoryItems · object[]

A list of inventory items associated with the product.

Show child attributes

data.inventory_items.inventory_item_id

string

required

ID of the inventory item. Can be passed into the Inventory endpoint for more details.

Example:

"inv_id"

data.inventory_items.sku

string | null

required

data.inventory_items.unit_quantity

integer

required

The number of units of the inventory item in the product.

Example:

0

Example:

[
  {
    "inventory_item_id": "id1",
    "sku": "sku1",
    "unit_quantity": 1
  },
  {
    "inventory_item_id": "id2",
    "sku": "sku2",
    "unit_quantity": 1
  }
]

data.is_kit

boolean

Example:

true

data.active

boolean

Whether the product is active.

Example:

true

data.supplier

string | null

Deprecated in favor of supplier_object.

Example:

"supplier"

data.supplier_object

ProductSupplier · object

Show child attributes

data.supplier_object.supplier_id

string

required

The ID of the supplier.

Example:

"supplier_id"

data.supplier_object.supplier_name

string | null

required

The name of the supplier.

Example:

"supplier_name"

data.country_of_origin

string | null

The country of origin of the product.

Example:

"USA"

data.harmonized_code

string | null

The harmonized HS code of the product.

Example:

"123456"

data.supplier_products

ProductSupplierProducts · object[]

A list of supplier products associated with the product.

Show child attributes

data.supplier_products.supplier_id

string

required

ID of the supplier.

Example:

"sup_id"

data.supplier_products.supplier_name

string | null

required

Name of the supplier.

Example:

"sup_name"

data.supplier_products.external_id

string | null

required

The external ID of the product from the supplier.

Example:

"ext_id"

data.supplier_products.unit_cost

string | null

required

The cost of the product from the supplier.

Example:

"unit_cost"

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

data.external_system_url

string | null

URL link to the product in the external system (WMS/Freight etc).

Example:

"https://example.com/product/123"

data.trackstar_tags

any[] | null

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

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"product.created"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

Response

200

Success

Home

How-To Guides

Use Cases

Body

Response