Get Cart Product

curl --request GET \
  --url https://production.trackstarhq.com/cart/products/{product_id} \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": {
    "id": "product_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "product_name",
    "sku": "sku",
    "gtin": "gtin",
    "parent_product_id": "<string>",
    "is_kit": true,
    "active": true,
    "image_url": "https://example.com/image.jpg",
    "price": 10,
    "unit_cost": 10,
    "inventory": 10,
    "inventory_by_warehouse_id": {
      "warehouse_id_1": 6,
      "warehouse_id_2": 4
    },
    "tags": [
      "tag_0"
    ],
    "external_system_url": "https://example.com/cartproduct/123",
    "additional_fields": {
      "key": "value"
    }
  }
}

GET

cart

products

{product_id}

Get Cart Product

curl --request GET \
  --url https://production.trackstarhq.com/cart/products/{product_id} \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": {
    "id": "product_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "product_name",
    "sku": "sku",
    "gtin": "gtin",
    "parent_product_id": "<string>",
    "is_kit": true,
    "active": true,
    "image_url": "https://example.com/image.jpg",
    "price": 10,
    "unit_cost": 10,
    "inventory": 10,
    "inventory_by_warehouse_id": {
      "warehouse_id_1": 6,
      "warehouse_id_2": 4
    },
    "tags": [
      "tag_0"
    ],
    "external_system_url": "https://example.com/cartproduct/123",
    "additional_fields": {
      "key": "value"
    }
  }
}

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

Path Parameters

product_id

string

required

Response

Successful response

data

CartProductSchema · object

Show child attributes

data.id

string

The unique ID of the product.

Example:

"product_id"

data.created_date

string<date-time>

The date the cart product was created.

Example:

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

data.updated_date

string<date-time>

The date the cart product was last updated.

Example:

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

data.name

string

The name of the product.

Example:

"product_name"

data.sku

string | null

The SKU of the product.

Example:

"sku"

data.gtin

string | null

The GTIN of the product.

Example:

"gtin"

data.parent_product_id

string

If this is a variant, the ID of the parent product. If this is a parent product, this field should be the same as ID.

data.is_kit

boolean

Example:

true

data.active

boolean

Whether the product is active.

Example:

true

data.image_url

string | null

The URL of the product's image.

Example:

"https://example.com/image.jpg"

data.price

number | null

The price of the product if it is a variant. Not the source of truth for parent products.

Example:

10

data.unit_cost

number | null

The unit cost of the product if it is a variant. Not the source of truth for parent products.

Example:

10

data.inventory

integer | null

The inventory of the product if it is a variant. Not the source of truth for parent products.

Example:

10

data.inventory_by_warehouse_id

object

Inventory broken down by warehouse.

Show child attributes

data.inventory_by_warehouse_id.{key}

integer

Inventory for that warehouse.

Example:

5

Example:

{ "warehouse_id_1": 6, "warehouse_id_2": 4 }

data.tags

string[]

A list of tags associated with the product. Tags that are represented as key-value pairs in the underlying system will be represented as a single string formatted as key:value.

A tag associated with the product.

Example:

["tag_0"]

data.external_system_url

string | null

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

Example:

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

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

Get All Cart Products Adjust Inventory for Product

⌘I

Cart API Reference

Headers

Path Parameters

Response