Create a Kit Product

POST

wms

kits

curl --request POST \
  --url https://production.trackstarhq.com/wms/kits \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "sku": "sku",
  "name": "name",
  "gtin": "gtin",
  "measurements": {
    "length": 1.5,
    "width": 1.5,
    "height": 1.5,
    "unit": "in",
    "weight": 2.5,
    "weight_unit": "lb"
  },
  "inventory_items": [
    {
      "inventory_item_id": "inventory_item_id",
      "sku": "sku",
      "unit_quantity": 1
    }
  ],
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ]
}'

{
  "data": {
    "id": "product_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "name",
    "sku": "sku",
    "gtin": "gtin",
    "unit_price": 10.99,
    "inventory_items": [
      {
        "inventory_item_id": "id1",
        "sku": "sku1",
        "unit_quantity": 1
      },
      {
        "inventory_item_id": "id2",
        "sku": "sku2",
        "unit_quantity": 1
      }
    ],
    "is_kit": true,
    "active": true,
    "supplier": "supplier",
    "supplier_object": {},
    "country_of_origin": "USA",
    "harmonized_code": "123456",
    "supplier_products": [
      {
        "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
      }
    ],
    "external_system_url": "https://example.com/product/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ]
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token

string

required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Body

application/json

sku

string

sku

Example:

"sku"

name

string

name

Example:

"name"

gtin

string

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

Example:

"gtin"

measurements

object

inventory_items

object[]

Inventory Items that make up this kit.

Example:

[
  {
    "inventory_item_id": "inventory_item_id",
    "sku": "sku",
    "unit_quantity": 1
  }
]

trackstar_tags

any[] | null

A list of custom tags associated with the kits. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Example:

["tag1", "tag2", { "tag3": "value3" }]

Response

200

application/json

Successful response

data

object

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

The date the product was created.

Example:

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

data.updated_date

string

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

object[]

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

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

object | null

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

object[]

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

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 product. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Example:

["tag1", "tag2", { "tag3": "value3" }]

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Update Product Update a Kit Product

curl --request POST \
  --url https://production.trackstarhq.com/wms/kits \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "sku": "sku",
  "name": "name",
  "gtin": "gtin",
  "measurements": {
    "length": 1.5,
    "width": 1.5,
    "height": 1.5,
    "unit": "in",
    "weight": 2.5,
    "weight_unit": "lb"
  },
  "inventory_items": [
    {
      "inventory_item_id": "inventory_item_id",
      "sku": "sku",
      "unit_quantity": 1
    }
  ],
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ]
}'

{
  "data": {
    "id": "product_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "name",
    "sku": "sku",
    "gtin": "gtin",
    "unit_price": 10.99,
    "inventory_items": [
      {
        "inventory_item_id": "id1",
        "sku": "sku1",
        "unit_quantity": 1
      },
      {
        "inventory_item_id": "id2",
        "sku": "sku2",
        "unit_quantity": 1
      }
    ],
    "is_kit": true,
    "active": true,
    "supplier": "supplier",
    "supplier_object": {},
    "country_of_origin": "USA",
    "harmonized_code": "123456",
    "supplier_products": [
      {
        "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
      }
    ],
    "external_system_url": "https://example.com/product/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ]
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

WMS API Reference

Headers

Body

Response