Skip to main content
POST
Create a customization (design sketch)
OAuth scope: offer_writeAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a shop-bound customization (design sketch) for a product template. When regions are supplied, the sync design pipeline runs immediately and the response carries the rendered preview images; with no regions, only the sketch is created and the response carries pipelineId: null and an empty images list. To iterate, re-POST with adjusted selections — there is no update-in-place.

productTemplateId
string
required

Id of the product template the sketch targets, from GET /open-api/v1.0/product-templates. Same id space as CreateDesignProductRequestV1.productTemplateId.

Example:

"pro_k66ZW4fsRm6c2def3itltA"

regions
Product Design Region · object[]

Design regions to render on the product. Each region references a registered media-library image by id (register first via POST /open-api/v1.0/media/images and pass the returned id as imageId). Omit or pass an empty list to create the sketch without running the pipeline.

colors
string[]

Colors to render. Defaults to all available product colors.

sizes
string[]

Sizes to include. Defaults to all available product sizes.

Response

Created

Response from creating a customization. pipelineId and images are populated only when regions were supplied in the request.

customizationId
string
required

Id of the newly created customization sketch.

Example:

"cst_k66ZW4fsRm6c2def3itltA"

images
Design Pipeline Image · object[]
required

Rendered preview images. Empty when no regions were supplied.

pipelineId
string

Id of the design pipeline run; null when no regions were supplied.

Example:

"dpl_k66ZW4fsRm6c2def3itltA"