Cart product created

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

CartProductSchema · object

required

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

event_type

string

required

Example:

"cart-product.created"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"cart"

Response

200

Success

Home

How-To Guides

Use Cases

Cart product created

Body

Response