The Pretty Product Options API

List all templates.

Response

{ "templates": [{ "id": "…", "name": "Roller blinds", "product_config_id": null }] }

• product_config_id set means a per-product option set; null means a shared template.

Create a template.

Request body

{ "name": "Roller blinds" }

Response

201 { "ok": true, "id": "…" }

Read the full tree: template, sections → options → choices, visibility rules, and the ruleset version list.

Update the structure declaratively.

Request body

{
  "name": "Roller blinds",
  "sections": [
    {
      "title": "Size",
      "options": [
        { "key": "width",  "label": "Width (cm)",  "input_type": "number", "required": true, "default_value": "120" },
        { "key": "height", "label": "Height (cm)", "input_type": "number", "required": true, "default_value": "150" }
      ]
    },
    {
      "title": "Fabric",
      "options": [
        {
          "key": "fabric", "label": "Fabric", "input_type": "single_select",
          "required": true, "display_mode": "swatch",
          "choices": [
            { "label": "Blockout White", "value": "blockout_white", "swatch_color": "#f5f5f0" },
            { "label": "Sunscreen 5%",   "value": "sunscreen_5", "price": 15 }
          ]
        }
      ]
    }
  ]
}

• sections replaces the whole structure declaratively (options and choices get new ids).
• Visibility rules are cleared when sections is provided — pricing rules are unaffected because conditions reference stable option keys.
• Omit sections to rename only.

Remove the template and everything under it.

Read the live ruleset the storefront prices with: rules, validations, version and base price.

Replace the rules as a new version.

Request body

{
  "rules": [
    { "kind": "adder", "config": { "label": "Base price", "amount": 89 } },
    { "kind": "raw_expression", "config": { "label": "Size", "expression": "(width/100)*(height/100)*65" } },
    {
      "kind": "multiplier", "config": { "label": "Motorised", "factor": 1.25 },
      "applies_when": { "combinator": "and", "conditions": [{ "option_key": "control_type", "operator": "eq", "value": "motorised" }] }
    }
  ],
  "validations": [
    {
      "conditions": { "combinator": "or", "conditions": [{ "option_key": "width", "operator": "lt", "value": 30 }] },
      "action": "block", "block_message": "Minimum width is 30 cm."
    }
  ],
  "publish": true
}

• Creates a new draft version containing exactly these rules; bad rules fail compilation with 422.
• validations, when present, replaces the template's validation rules.
• publish: true makes it live immediately.
• Rule kinds: adder, multiplier, dimension_lookup, tier, raw_expression.

Compute a price for a configuration.

Request body

{
  "product_config_id": "…",
  "selections": { "fabric": "sunscreen_5", "control_type": "motorised" },
  "dimensions": { "width": 120, "height": 150 }
}

Response

{ "price": 262.13, "breakdown": { … }, "validation": { "ok": true }, "ruleset_version": 7 }

• Batch: { "items": [ …same shape… ] } → { "results": […] }.

Create a Shopify draft order with configured lines — returns the invoice link.

Request body

{
  "items": [
    {
      "product_config_id": "…",
      "selections": { "fabric": "sunscreen_5" },
      "dimensions": { "width": 120, "height": 150 },
      "quantity": 2
    }
  ],
  "email": "customer@example.com"
}

Response

{ "ok": true, "invoice_url": "…" }

• Prices are locked at creation — the customer opens the link and pays.
• Items may use shopify_product_id instead of product_config_id.
• Validation blocks return 422 with the blocking message.

Same items shape, editable vehicle: a link that rebuilds the items in the customer's cart.

Request body

{ "items": [ …same shape as draft-orders… ] }

Response

{ "ok": true, "url": "https://your-store.com/cart?coverly_cart=…" }

• Items are re-priced and re-signed when the link is opened — never stale.
• The customer can edit any line in their cart before checking out.
• Use draft orders for agreed quotes; cart links for editable proposals.

List all configured products.

Connect or update a product.

Request body

{ "anchor_variant_id": 45678901234, "template_id": "…", "base_config": { … }, "currency_mode": "auto_convert" }

• base_config and currency_mode are optional.

Disconnect the configurator from the product.

List customer groups.

Create a group keyed to a customer tag.

Request body

{ "name": "Wholesale", "tag": "wholesale" }

Delete a group.

Query saved configurations by status and time window.