Skip to main content
POST
/
wms
/
kits
Create 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 '{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "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
    }
  ]
}'
{
  "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": {
      "supplier_id": "supplier_id",
      "supplier_name": "supplier_name"
    },
    "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"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "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
  • Base_Schema
  • Cin7 Core (Dear Systems)
  • Extensiv (3PL Central)
  • Infoplus
  • MasonHub
  • Ongoing WMS
  • WMS Sandbox
  • ShipHero
  • ShipStream
  • Shipwire
  • Linnworks Core (SKUVault)
  • Whiplash (Ryder)
​
sku
string
required

sku

Example:

"sku"

​
name
string
required

name

Example:

"name"

​
gtin
string
required

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

Example:

"gtin"

​
measurements
object
required
​
inventory_items
ProductKitComponents · object[]
required

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 resource. A tag can be either a string or a dictionary with one key-value pair.

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

Response

Successful response

​
data
object
​
id
string

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]

Unused fields

⌘I