/products/{id}/

Time	Status	User Agent
Retrieving recent requests…

Path Params

string

required

A unique integer value identifying this product.

Query Params

string

Filter by a product id.

reference_id

string

Filter by an product reference id.

created_at_before

date-time

Show after created_at. Structured in ISO 8601 datetime format (ex: 2014-04-25T16:15:47-04:00)

created_at_after

date-time

Show after created_at. Structured in ISO 8601 datetime format (ex: 2014-04-25T16:15:47-04:00)

shop_key

string

Filter by Shop Key. Multiple allowed. (?shop_key=123&shop_key=789)

ids

string

ids

Body Params

description

boolean

Description of the product. Overrides product template description if field is provided.

name

boolean

Name of your product. Defaults to item name.

print_areas

array of objects

required

The artwork for each print area. Blank items (such as a gift box) take none.

print_areas*

product_tags

array of strings

Adds given tags to existing product template tags.

product_tags

product_template

integer

required

The ID of the product template. Product Template or Item is required.

shops

array of strings

List of Shop Keys to publish the product to.

shops

item

integer

required

The ID of an Item. Item or Product Template is required.

primary_color

integer

required

The ID of the primary color. Used for display purposes on marketplaces.

create_default_mockups

boolean

Mockups that are displayed on the designer by default for the item will be created for this product. Defaults to True if item is used to create product.

item_variants

array of objects

required

item_variants*

personalized

boolean

Set personalized to true if the product will require personalization after it has been purchased.

marketplace_draft

boolean

Set to true if the product should be published to marketplaces as a draft instead of live a live product.

ai_personalization

boolean

Set to true to have Dreamship's AI draw each order's artwork from ai_print_areas and what the buyer answers on the listing. The business needs a connected Etsy shop, and the product publishes to Etsy shops only. Cannot be combined with personalized. Left out on an update, it stays as it is; false turns it off.

ai_print_areas

array of objects

Required with ai_personalization: each print area the AI redraws, with its prompt and the listing's questions. An item sold in sizes of one design (a mug, a poster) takes one entry, which covers every size.

ai_print_areas

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

200