v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB

Design Pipeline

Create a design preview

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Deprecated. Use POST /open-api/v1.0/products (type=design) to create design products. Creates a design preview pipeline that generates product mockup images synchronously. Submit product and design placement info, receive pipelineId, customizationId, and rendered images directly in the response.

post/open-api/v1.0/design-pipeline/previews

Request body

customizationIdstring

productIdstring

colorsstring[]

sizesstring[]

metadataobject

Arbitrary key-value metadata stored on the pipeline and returned by the status endpoint. At most 25 entries; keys up to 100 characters, values up to 1000 characters.

Example request

{
  "regions": [
    {
      "region": "front",
      "placementStrategy": "AUTO"
    }
  ]
}

Response

Created

pipelineIdstring required

customizationIdstring