/v1/workspaces/{workspace_id}/data/products

Path Params
string
required
Body Params
string
enum
Allowed:
string
string
data
array of objects
required
length between 1 and 500
data*
string | null

A description of the product. Supports HTML formatting.

date-time
required

The date and time (ISO 8601 format) when the product was created.

string | null

A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects.

string
required
length ≥ 1

An unsigned 64-bit integer that's used as a unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id, even if they're from different shops.

images
array of objects or null | null

A list of product image objects, each one representing an image associated with the product.

images
options
array of objects or null | null

The custom product properties.

options
string | null

A categorization for the product used for filtering and searching products.

date-time | null

The date and time (ISO 8601 format) when the product was published.

string | null

Whether the product is published to the Point of Sale channel.

string | null

The status of the product.

string | null

A string of comma-separated tags that are used for filtering and search.

string | null

The suffix of the Liquid template used for the product page.

string | null

The name of the product.

date-time | null

The date and time (ISO 8601 format) when the product was last modified.

variants
array of objects or null | null

An array of product variants, each representing a different version of the product.

variants
string | null
additional_fields
array of objects | null

Extra properties.

additional_fields
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json