Skip to content

`product` object¶

A product object contains the properties that define a product in DropStream.

Product objects are managed by the /products endpoint.

`product` properties¶

The following are the properties of a product object.

`id`¶

Property	`id`
Data type	integer
Description	Unique ID of this product, assigned upon creation
Note	In other contexts, `"product_id"` refers to this property
Example	`12345`

`customer_id`¶

Property	`customer_id`
Data type	integer
Description	Unique ID of the customer associated with this product
Example	`23456`

`sku`¶

Property	`sku`
Data type	string
Description	The SKU of this product
Example	`"abc-123"`

`variant_of`¶

Property	`variant_of`
Data type	string
Description	If specified, defines this product as a variant. The value must correspond to the `name` of a previously-defined `variant_collection` object.
Example	`"Shoes"`

`bundle`¶

Property	`bundle`
Data type	array of bundle components
Description	If specified, defines the product as a bundle. Each element of the array is a bundle component: an object containing a `product_id` and a quantity `qty`.
Example	`[ { "product_id": 12345, "qty": 2 }, { "product_id": 23456, "qty": 3 } ]`

`master_id`¶

Property	`master_id`
Data type	integer
Description	Defines the Master ID of this product.
Example	`12345`

`created_at`¶

Property	`created_at`
Data type	dateString
Description	Date when the product was created
Example	`"2020-08-19T14:57:20.000Z"`

Example `product` object¶

JSON

{
  "id": 12345,
  "customer_id": 23456,
  "sku": "abc-123",
  "created_at": "2021-08-02T21:07:39.000Z",
  "variant_of": "Shoes",
  "master_id": 34567,
  "bundle": [
    {
      "product_id": 45678,
      "qty": 2
    }
  ]
}