v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB

Customizations

Create a customization (design sketch)

Rate limit: 5 requests / minute per shop. See Rate limiting.

Creates a shop-bound customization sketch on 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 (pipelineId: null, images: []). Iteration = re-POST with adjusted selections; there is no update-in-place.

post/open-api/v1.0/customizations

Request body

productTemplateIdstring required

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

colorsstring[]

Colors to render. Defaults to all available product colors.

sizesstring[]

Sizes to include. Defaults to all available product sizes.

Example request

{
  "productTemplateId": "pro_k66ZW4fsRm6c2def3itltA",
  "regions": [
    {
      "region": "front",
      "imageId": "img_k66ZW4fsRm6c2def3itltA",
      "placementStrategy": "AUTO"
    }
  ]
}

Response

Created

customizationIdstring required

Id of the newly created customization sketch.

pipelineIdstring

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

Example response

{
  "customizationId": "cst_k66ZW4fsRm6c2def3itltA",
  "pipelineId": "dpl_k66ZW4fsRm6c2def3itltA"
}