{
    "openapi": "3.0.3",
    "info": {
        "title": "Integration API",
        "version": "v1",
        "description": "Catalog, orders and content for an external system (ERP, PIM, CRM, accounting). Authenticated with an integration key whose abilities are chosen in the store admin. Available on the Pro plan and above. Prices are integer minor units: 49000 means 490.00. A key only receives the abilities chosen in the admin: catalog:read, catalog:write, inventory:write, orders:read, orders:write-status, customers:read, content:read, content:write. The same abilities will gate MCP tools. v1 only grows: new endpoints, optional parameters, response fields and webhook events may appear at any time, so clients must ignore fields and events they do not know. Anything else is a v2 beside v1."
    },
    "servers": [
        {
            "url": "https://{store}/api/v1/integrations",
            "variables": {
                "store": {
                    "default": "your-store.storeforma.shop",
                    "description": "The store’s domain."
                }
            }
        }
    ],
    "security": [
        {
            "bearer": []
        }
    ],
    "tags": [
        {
            "name": "Products",
            "description": "Read the catalog with its variants (offers)."
        },
        {
            "name": "Catalog sync",
            "description": "Create and update products, categories and tags by your own ids (external ids). Every call is an idempotent upsert."
        },
        {
            "name": "Orders",
            "description": "Pull placed orders with their lines, buyer, delivery and payment, and move them through fulfilment."
        },
        {
            "name": "Customers",
            "description": "The store’s customer accounts, for a CRM or a mailing list."
        },
        {
            "name": "Inventory",
            "description": "Stock of any product by SKU, also of products made in the admin: for a CRM, an accounting system or a warehouse."
        },
        {
            "name": "Content",
            "description": "Pages and blog posts: list, write drafts, publish."
        }
    ],
    "paths": {
        "/products": {
            "get": {
                "operationId": "list-products",
                "tags": [
                    "Products"
                ],
                "summary": "List products",
                "description": "A page of the catalog in id order. Page with page and limit; narrow with filter[name] or filter[sku]. Add include=offers for the variants with their own SKU, price and stock.\n\nRequires catalog:read.",
                "parameters": [
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Page number, starting at 1.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 1
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "Page size. Default 15, maximum 50.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 15
                    },
                    {
                        "name": "filter[name]",
                        "in": "query",
                        "required": false,
                        "description": "Part of the product name.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "навушники"
                    },
                    {
                        "name": "filter[sku]",
                        "in": "query",
                        "required": false,
                        "description": "Exact SKU of a variant.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "SONAR-ANC-BLK"
                    },
                    {
                        "name": "include",
                        "in": "query",
                        "required": false,
                        "description": "offers adds the variants to every product.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "offers"
                            ]
                        },
                        "example": "offers"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of products.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "current_page": 1,
                                    "data": [
                                        {
                                            "id": 12,
                                            "name": "Навушники Sonar ANC повнорозмірні",
                                            "description": "Активне шумозаглушення, 40 годин роботи.",
                                            "sku": "SONAR-ANC-BLK",
                                            "thumbnail_url": "https://your-store.storeforma.shop/media/12/sonar-anc.webp",
                                            "quantity": 24,
                                            "currency_code": "UAH",
                                            "min_price": 599900,
                                            "max_price": 599900,
                                            "weight": 0.32,
                                            "length": null,
                                            "height": null,
                                            "width": null,
                                            "has_offers": false,
                                            "is_archived": false,
                                            "category_id": 7,
                                            "attributes": [
                                                {
                                                    "handle": "kolir",
                                                    "name": "Колір",
                                                    "type": "swatch",
                                                    "unit": null,
                                                    "group": null,
                                                    "variant_axis": false,
                                                    "values": [
                                                        "Чорний"
                                                    ]
                                                },
                                                {
                                                    "handle": "vaga",
                                                    "name": "Вага",
                                                    "type": "number",
                                                    "unit": "г",
                                                    "group": "Загальні",
                                                    "variant_axis": false,
                                                    "values": [
                                                        "320 г"
                                                    ]
                                                }
                                            ],
                                            "input_options": [
                                                {
                                                    "key": "hraviiuvannia",
                                                    "label": "Гравіювання",
                                                    "type": "text",
                                                    "required": false,
                                                    "price": 10000,
                                                    "max": 30,
                                                    "choices": []
                                                }
                                            ],
                                            "created_at": "2026-10-01 10:12:00",
                                            "updated_at": "2026-10-12 08:40:00",
                                            "offers": [
                                                {
                                                    "id": 15,
                                                    "sku": "SONAR-ANC-BLK",
                                                    "price": 599900,
                                                    "quantity": 24,
                                                    "properties": [
                                                        {
                                                            "name": "Колір",
                                                            "value": "Чорний"
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                    ],
                                    "from": 1,
                                    "last_page": 1,
                                    "per_page": 15,
                                    "to": 1,
                                    "total": 1,
                                    "path": "https://your-store.storeforma.shop/api/v1/integrations/products",
                                    "next_page_url": null,
                                    "prev_page_url": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks catalog:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot catalog:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/products/{id}": {
            "get": {
                "operationId": "show-product",
                "tags": [
                    "Products"
                ],
                "summary": "Get a product",
                "description": "One product by its id in this store. include=offers adds its variants.\n\nRequires catalog:read.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "Product id in this store.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 12
                    },
                    {
                        "name": "include",
                        "in": "query",
                        "required": false,
                        "description": "offers adds the variants.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "offers"
                            ]
                        },
                        "example": "offers"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The product.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": {
                                        "id": 12,
                                        "name": "Навушники Sonar ANC повнорозмірні",
                                        "description": "Активне шумозаглушення, 40 годин роботи.",
                                        "sku": "SONAR-ANC-BLK",
                                        "thumbnail_url": "https://your-store.storeforma.shop/media/12/sonar-anc.webp",
                                        "quantity": 24,
                                        "currency_code": "UAH",
                                        "min_price": 599900,
                                        "max_price": 599900,
                                        "weight": 0.32,
                                        "length": null,
                                        "height": null,
                                        "width": null,
                                        "has_offers": false,
                                        "is_archived": false,
                                        "category_id": 7,
                                        "attributes": [
                                            {
                                                "handle": "kolir",
                                                "name": "Колір",
                                                "type": "swatch",
                                                "unit": null,
                                                "group": null,
                                                "variant_axis": false,
                                                "values": [
                                                    "Чорний"
                                                ]
                                            },
                                            {
                                                "handle": "vaga",
                                                "name": "Вага",
                                                "type": "number",
                                                "unit": "г",
                                                "group": "Загальні",
                                                "variant_axis": false,
                                                "values": [
                                                    "320 г"
                                                ]
                                            }
                                        ],
                                        "input_options": [
                                            {
                                                "key": "hraviiuvannia",
                                                "label": "Гравіювання",
                                                "type": "text",
                                                "required": false,
                                                "price": 10000,
                                                "max": 30,
                                                "choices": []
                                            }
                                        ],
                                        "created_at": "2026-10-01 10:12:00",
                                        "updated_at": "2026-10-12 08:40:00",
                                        "offers": [
                                            {
                                                "id": 15,
                                                "sku": "SONAR-ANC-BLK",
                                                "price": 599900,
                                                "quantity": 24,
                                                "properties": [
                                                    {
                                                        "name": "Колір",
                                                        "value": "Чорний"
                                                    }
                                                ]
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No product with this id.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "not_found",
                                    "message": "not_found",
                                    "field": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks catalog:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot catalog:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/catalog/products/{external_id}": {
            "put": {
                "operationId": "upsert-product",
                "tags": [
                    "Catalog sync"
                ],
                "summary": "Create or replace a product",
                "description": "Creates the product the first time an external_id is seen and updates the same product afterwards, so a retry never makes a duplicate. A new product needs name and sku; it gets one variant with that SKU, price and stock.\n\nCategories and tags are linked by your external ids, which must be created first; a list replaces the product’s links. image_url must be a public https image; it is downloaded into the store.\n\nFor a product in several colours or sizes send variants: each with its SKU, price, stock and options (the same option names in every variant). The list replaces the product’s variants: matched by SKU, new ones added, missing ones removed; a variant row without price or quantity keeps the variant’s own, a new variant needs its price. Without variants the product has one variant from sku, price and quantity.\n\nRequires catalog:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your product id, stable across retries (1–191 characters).",
                        "schema": {
                            "type": "string"
                        },
                        "example": "erp-10045"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": null,
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "Product name. Required for a new product."
                                    },
                                    "sku": {
                                        "type": "string",
                                        "description": "SKU of the product’s variant. Required for a new product."
                                    },
                                    "price": {
                                        "type": "integer",
                                        "description": "Price in minor units (599900 = 5 999.00)."
                                    },
                                    "quantity": {
                                        "type": "integer",
                                        "description": "Stock."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "Plain-text description."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "draft or published. Default draft.",
                                        "enum": [
                                            "draft",
                                            "published"
                                        ]
                                    },
                                    "image_url": {
                                        "type": "string",
                                        "description": "Public https URL of the main image."
                                    },
                                    "category_external_ids": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        },
                                        "description": "Your category ids; replaces the links."
                                    },
                                    "tag_external_ids": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        },
                                        "description": "Your tag ids; replaces the links."
                                    },
                                    "attributes": {
                                        "type": "object",
                                        "description": "Characteristics by name, such as {\"Матеріал\": [\"Бавовна\", \"Льон\"], \"Вага\": \"180 г\", \"Водонепроникний\": true}; null removes one, names not sent stay. For a store on the one attribute model; elsewhere tags carry characteristics."
                                    },
                                    "variants": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Up to 100 variants: sku (required), price, quantity and options, an object of option name → value such as {\"Колір\": \"Чорний\", \"Розмір\": \"M\"}. When present, the top-level sku, price and quantity are not used."
                                    }
                                }
                            },
                            "example": {
                                "name": "Навушники Sonar ANC повнорозмірні",
                                "description": "Активне шумозаглушення, 40 годин роботи.",
                                "status": "published",
                                "image_url": "https://cdn.example.com/sonar-anc.jpg",
                                "category_external_ids": [
                                    "erp-cat-audio"
                                ],
                                "tag_external_ids": [
                                    "erp-tag-new"
                                ],
                                "variants": [
                                    {
                                        "sku": "SONAR-ANC-BLK",
                                        "price": 599900,
                                        "quantity": 24,
                                        "options": {
                                            "Колір": "Чорний"
                                        }
                                    },
                                    {
                                        "sku": "SONAR-ANC-WHT",
                                        "price": 599900,
                                        "quantity": 9,
                                        "options": {
                                            "Колір": "Білий"
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The product as the catalog now shows it, with your external_id.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "external_id": "erp-10045",
                                    "data": {
                                        "id": 12,
                                        "name": "Навушники Sonar ANC повнорозмірні",
                                        "description": "Активне шумозаглушення, 40 годин роботи.",
                                        "sku": "SONAR-ANC-BLK",
                                        "thumbnail_url": "https://your-store.storeforma.shop/media/12/sonar-anc.webp",
                                        "quantity": 24,
                                        "currency_code": "UAH",
                                        "min_price": 599900,
                                        "max_price": 599900,
                                        "weight": 0.32,
                                        "length": null,
                                        "height": null,
                                        "width": null,
                                        "has_offers": false,
                                        "is_archived": false,
                                        "category_id": 7,
                                        "attributes": [
                                            {
                                                "handle": "kolir",
                                                "name": "Колір",
                                                "type": "swatch",
                                                "unit": null,
                                                "group": null,
                                                "variant_axis": false,
                                                "values": [
                                                    "Чорний"
                                                ]
                                            },
                                            {
                                                "handle": "vaga",
                                                "name": "Вага",
                                                "type": "number",
                                                "unit": "г",
                                                "group": "Загальні",
                                                "variant_axis": false,
                                                "values": [
                                                    "320 г"
                                                ]
                                            }
                                        ],
                                        "input_options": [
                                            {
                                                "key": "hraviiuvannia",
                                                "label": "Гравіювання",
                                                "type": "text",
                                                "required": false,
                                                "price": 10000,
                                                "max": 30,
                                                "choices": []
                                            }
                                        ],
                                        "created_at": "2026-10-01 10:12:00",
                                        "updated_at": "2026-10-12 08:40:00"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks catalog:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot catalog:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            },
            "patch": {
                "operationId": "update-product",
                "tags": [
                    "Catalog sync"
                ],
                "summary": "Update part of a product",
                "description": "Changes only the fields you send, for example stock and price from an ERP. The product must already exist for this key (create it with PUT first). For a product with variants send the whole variants list.\n\nTo take a product off sale send status draft: products are hidden, never deleted, because orders keep referring to them.\n\nRequires catalog:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your product id.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "erp-10045"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": null,
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "Product name."
                                    },
                                    "sku": {
                                        "type": "string",
                                        "description": "SKU of the product’s variant."
                                    },
                                    "price": {
                                        "type": "integer",
                                        "description": "Price in minor units (599900 = 5 999.00)."
                                    },
                                    "quantity": {
                                        "type": "integer",
                                        "description": "Stock."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "Plain-text description."
                                    },
                                    "status": {
                                        "type": "string",
                                        "description": "draft or published.",
                                        "enum": [
                                            "draft",
                                            "published"
                                        ]
                                    },
                                    "image_url": {
                                        "type": "string",
                                        "description": "Public https URL of the main image."
                                    },
                                    "category_external_ids": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        },
                                        "description": "Your category ids; replaces the links."
                                    },
                                    "tag_external_ids": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        },
                                        "description": "Your tag ids; replaces the links."
                                    },
                                    "attributes": {
                                        "type": "object",
                                        "description": "Characteristics by name, such as {\"Матеріал\": [\"Бавовна\", \"Льон\"], \"Вага\": \"180 г\", \"Водонепроникний\": true}; null removes one, names not sent stay. For a store on the one attribute model; elsewhere tags carry characteristics."
                                    },
                                    "variants": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Up to 100 variants: sku (required), price, quantity and options, an object of option name → value such as {\"Колір\": \"Чорний\", \"Розмір\": \"M\"}. When present, the top-level sku, price and quantity are not used."
                                    }
                                }
                            },
                            "example": {
                                "price": 549900,
                                "quantity": 18
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The updated product.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "external_id": "erp-10045",
                                    "data": {
                                        "id": 12,
                                        "name": "Навушники Sonar ANC повнорозмірні",
                                        "description": "Активне шумозаглушення, 40 годин роботи.",
                                        "sku": "SONAR-ANC-BLK",
                                        "thumbnail_url": "https://your-store.storeforma.shop/media/12/sonar-anc.webp",
                                        "quantity": 24,
                                        "currency_code": "UAH",
                                        "min_price": 599900,
                                        "max_price": 599900,
                                        "weight": 0.32,
                                        "length": null,
                                        "height": null,
                                        "width": null,
                                        "has_offers": false,
                                        "is_archived": false,
                                        "category_id": 7,
                                        "attributes": [
                                            {
                                                "handle": "kolir",
                                                "name": "Колір",
                                                "type": "swatch",
                                                "unit": null,
                                                "group": null,
                                                "variant_axis": false,
                                                "values": [
                                                    "Чорний"
                                                ]
                                            },
                                            {
                                                "handle": "vaga",
                                                "name": "Вага",
                                                "type": "number",
                                                "unit": "г",
                                                "group": "Загальні",
                                                "variant_axis": false,
                                                "values": [
                                                    "320 г"
                                                ]
                                            }
                                        ],
                                        "input_options": [
                                            {
                                                "key": "hraviiuvannia",
                                                "label": "Гравіювання",
                                                "type": "text",
                                                "required": false,
                                                "price": 10000,
                                                "max": 30,
                                                "choices": []
                                            }
                                        ],
                                        "created_at": "2026-10-01 10:12:00",
                                        "updated_at": "2026-10-12 08:40:00"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks catalog:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot catalog:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/catalog/categories/{external_id}": {
            "put": {
                "operationId": "upsert-category",
                "tags": [
                    "Catalog sync"
                ],
                "summary": "Create or rename a category",
                "description": "Creates the category on first use and renames it afterwards. Link products to it with category_external_ids.\n\nRequires catalog:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your category id.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "erp-cat-audio"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "name"
                                ],
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "description": "Category name."
                                    }
                                }
                            },
                            "example": {
                                "name": "Аудіо"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The category.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "external_id": "erp-cat-audio",
                                    "data": {
                                        "id": 7,
                                        "name": "Аудіо"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks catalog:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot catalog:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/catalog/tags/{external_id}": {
            "put": {
                "operationId": "upsert-tag",
                "tags": [
                    "Catalog sync"
                ],
                "summary": "Create or rename a tag",
                "description": "Creates a catalog tag on first use and renames it afterwards. Values are stored in upper case. Status labels (such as sale or new badges the store manages itself) are rejected.\n\nRequires catalog:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your tag id.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "erp-tag-wireless"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "value"
                                ],
                                "properties": {
                                    "value": {
                                        "type": "string",
                                        "description": "Tag text."
                                    }
                                }
                            },
                            "example": {
                                "value": "Bluetooth 5.3"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The tag.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "external_id": "erp-tag-wireless",
                                    "data": {
                                        "id": 31,
                                        "value": "BLUETOOTH 5.3",
                                        "display_mode": "content"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks catalog:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot catalog:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/orders": {
            "get": {
                "operationId": "list-orders",
                "tags": [
                    "Orders"
                ],
                "summary": "List orders",
                "description": "Placed orders in id order with everything needed to book them: totals, lines with SKU and price, the buyer, delivery (carrier, city, branch or address), payment method and the buyer’s note. Page with cursor: pass the previous response’s next_cursor until it is null. To pick up changes, pass updated_since with the time of your last sync.\n\nFor changes as they happen, subscribe to webhooks (order.created, order.status_changed) in the admin instead of polling.\n\nRequires orders:read.",
                "parameters": [
                    {
                        "name": "updated_since",
                        "in": "query",
                        "required": false,
                        "description": "Only orders updated at or after this time (YYYY-MM-DD HH:MM:SS, store time zone).",
                        "schema": {
                            "type": "string"
                        },
                        "example": "2026-10-01 00:00:00"
                    },
                    {
                        "name": "cursor",
                        "in": "query",
                        "required": false,
                        "description": "Return orders with an id greater than this (next_cursor of the previous page).",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 1040
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "Page size. Default 15, maximum 50.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 15
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of orders and the cursor of the next one.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": [
                                        {
                                            "id": 1044,
                                            "reference": "2026-001044",
                                            "status": "payment-received",
                                            "total": 214000,
                                            "currency_code": "UAH",
                                            "placed_at": "2026-10-12 14:03:11",
                                            "updated_at": "2026-10-12 16:20:45",
                                            "customer": {
                                                "name": "Олена Коваль",
                                                "email": "olena@example.com",
                                                "phone": "+380671234567",
                                                "first_name": "Олена",
                                                "last_name": "Коваль",
                                                "customer_id": 318
                                            },
                                            "subtotal": 214000,
                                            "shipping_total": 0,
                                            "discount_total": 0,
                                            "tax_total": 0,
                                            "lines": [
                                                {
                                                    "id": 5012,
                                                    "product_id": 12,
                                                    "variant_id": 15,
                                                    "sku": "SONAR-ANC-BLK",
                                                    "name": "Навушники Sonar ANC повнорозмірні",
                                                    "option": "Чорний · Гравіювання: Для Ані",
                                                    "quantity": 1,
                                                    "unit_price": 199000,
                                                    "total": 199000
                                                },
                                                {
                                                    "id": 5013,
                                                    "product_id": 31,
                                                    "variant_id": 40,
                                                    "sku": "CASE-01",
                                                    "name": "Чохол для навушників",
                                                    "option": null,
                                                    "quantity": 1,
                                                    "unit_price": 15000,
                                                    "total": 15000
                                                }
                                            ],
                                            "shipping": {
                                                "method": "Нова пошта",
                                                "carrier": "nova_poshta",
                                                "service_type": "branch",
                                                "city_name": "Київ",
                                                "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                                                "delivery_point_name": "Відділення №12",
                                                "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                                                "address": {
                                                    "line_one": "Відділення №12",
                                                    "line_two": null,
                                                    "city": "Київ",
                                                    "postcode": null,
                                                    "country": "UA"
                                                },
                                                "method_code": "NOVA_POSHTA"
                                            },
                                            "payment": {
                                                "method": "app:com.storeforma.wayforpay"
                                            },
                                            "notes": "Подзвоніть перед відправкою"
                                        }
                                    ],
                                    "next_cursor": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks orders:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot orders:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/orders/{reference}": {
            "get": {
                "operationId": "show-order",
                "tags": [
                    "Orders"
                ],
                "summary": "Get an order",
                "description": "One placed order by its reference, in the same shape as the list: totals, lines, the buyer, delivery, payment and the buyer’s note.\n\nRequires orders:read.",
                "parameters": [
                    {
                        "name": "reference",
                        "in": "path",
                        "required": true,
                        "description": "The order reference.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "2026-001044"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The order.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": {
                                        "id": 1044,
                                        "reference": "2026-001044",
                                        "status": "payment-received",
                                        "total": 214000,
                                        "currency_code": "UAH",
                                        "placed_at": "2026-10-12 14:03:11",
                                        "updated_at": "2026-10-12 16:20:45",
                                        "customer": {
                                            "name": "Олена Коваль",
                                            "email": "olena@example.com",
                                            "phone": "+380671234567",
                                            "first_name": "Олена",
                                            "last_name": "Коваль",
                                            "customer_id": 318
                                        },
                                        "subtotal": 214000,
                                        "shipping_total": 0,
                                        "discount_total": 0,
                                        "tax_total": 0,
                                        "lines": [
                                            {
                                                "id": 5012,
                                                "product_id": 12,
                                                "variant_id": 15,
                                                "sku": "SONAR-ANC-BLK",
                                                "name": "Навушники Sonar ANC повнорозмірні",
                                                "option": "Чорний · Гравіювання: Для Ані",
                                                "quantity": 1,
                                                "unit_price": 199000,
                                                "total": 199000
                                            },
                                            {
                                                "id": 5013,
                                                "product_id": 31,
                                                "variant_id": 40,
                                                "sku": "CASE-01",
                                                "name": "Чохол для навушників",
                                                "option": null,
                                                "quantity": 1,
                                                "unit_price": 15000,
                                                "total": 15000
                                            }
                                        ],
                                        "shipping": {
                                            "method": "Нова пошта",
                                            "carrier": "nova_poshta",
                                            "service_type": "branch",
                                            "city_name": "Київ",
                                            "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                                            "delivery_point_name": "Відділення №12",
                                            "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                                            "address": {
                                                "line_one": "Відділення №12",
                                                "line_two": null,
                                                "city": "Київ",
                                                "postcode": null,
                                                "country": "UA"
                                            },
                                            "method_code": "NOVA_POSHTA"
                                        },
                                        "payment": {
                                            "method": "app:com.storeforma.wayforpay"
                                        },
                                        "notes": "Подзвоніть перед відправкою"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No placed order with this reference.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "not_found",
                                    "message": "not_found",
                                    "field": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks orders:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot orders:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/orders/{reference}/status": {
            "post": {
                "operationId": "change-order-status",
                "tags": [
                    "Orders"
                ],
                "summary": "Change an order status",
                "description": "Moves an order along fulfilment. Allowed moves: awaiting-payment → payment-offline or cancelled; payment-offline and payment-received → dispatched or cancelled; in-progress → dispatched, delivered or cancelled; dispatched → delivered.\n\nPayment confirmation is never set here (it stays with the payment provider) and the order total does not change. Keys that also have orders:read and a webhook address receive a signed order.status_changed event.\n\nRequires orders:write-status.",
                "parameters": [
                    {
                        "name": "reference",
                        "in": "path",
                        "required": true,
                        "description": "The order reference (as in the admin and the buyer’s e-mail).",
                        "schema": {
                            "type": "string"
                        },
                        "example": "2026-001044"
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "description": "A unique key for this attempt (a UUID). Repeating it returns the first response.",
                        "schema": {
                            "type": "string",
                            "maxLength": 191
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "status"
                                ],
                                "properties": {
                                    "status": {
                                        "type": "string",
                                        "description": "The new status.",
                                        "enum": [
                                            "payment-offline",
                                            "cancelled",
                                            "dispatched",
                                            "delivered"
                                        ]
                                    }
                                }
                            },
                            "example": {
                                "status": "dispatched"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The order with its new status.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": {
                                        "id": 1044,
                                        "reference": "2026-001044",
                                        "status": "dispatched",
                                        "total": 214000,
                                        "currency_code": "UAH",
                                        "placed_at": "2026-10-12 14:03:11",
                                        "updated_at": "2026-10-12 16:20:45",
                                        "customer": {
                                            "name": "Олена Коваль",
                                            "email": "olena@example.com",
                                            "phone": "+380671234567",
                                            "first_name": "Олена",
                                            "last_name": "Коваль",
                                            "customer_id": 318
                                        },
                                        "subtotal": 214000,
                                        "shipping_total": 0,
                                        "discount_total": 0,
                                        "tax_total": 0,
                                        "lines": [
                                            {
                                                "id": 5012,
                                                "product_id": 12,
                                                "variant_id": 15,
                                                "sku": "SONAR-ANC-BLK",
                                                "name": "Навушники Sonar ANC повнорозмірні",
                                                "option": "Чорний · Гравіювання: Для Ані",
                                                "quantity": 1,
                                                "unit_price": 199000,
                                                "total": 199000
                                            },
                                            {
                                                "id": 5013,
                                                "product_id": 31,
                                                "variant_id": 40,
                                                "sku": "CASE-01",
                                                "name": "Чохол для навушників",
                                                "option": null,
                                                "quantity": 1,
                                                "unit_price": 15000,
                                                "total": 15000
                                            }
                                        ],
                                        "shipping": {
                                            "method": "Нова пошта",
                                            "carrier": "nova_poshta",
                                            "service_type": "branch",
                                            "city_name": "Київ",
                                            "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                                            "delivery_point_name": "Відділення №12",
                                            "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                                            "address": {
                                                "line_one": "Відділення №12",
                                                "line_two": null,
                                                "city": "Київ",
                                                "postcode": null,
                                                "country": "UA"
                                            },
                                            "method_code": "NOVA_POSHTA"
                                        },
                                        "payment": {
                                            "method": "app:com.storeforma.wayforpay"
                                        },
                                        "notes": "Подзвоніть перед відправкою"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No placed order with this reference.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "not_found",
                                    "message": "not_found",
                                    "field": null
                                }
                            }
                        }
                    },
                    "409": {
                        "description": "This Idempotency-Key was already used for a different request.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "idempotency_conflict",
                                    "message": "Idempotency-Key was already used for a different request.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks orders:write-status, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot orders:write-status.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/customers": {
            "get": {
                "operationId": "list-customers",
                "tags": [
                    "Customers"
                ],
                "summary": "List customers",
                "description": "Customer accounts of the store in id order, with cursor pagination like orders. updated_since picks up changes since your last sync.\n\ncustomers:read gives personal data: issue it only to systems that need it. New sign-ups also arrive as the customer.created webhook.\n\nRequires customers:read.",
                "parameters": [
                    {
                        "name": "updated_since",
                        "in": "query",
                        "required": false,
                        "description": "Only customers updated at or after this time (YYYY-MM-DD HH:MM:SS).",
                        "schema": {
                            "type": "string"
                        },
                        "example": "2026-10-01 00:00:00"
                    },
                    {
                        "name": "cursor",
                        "in": "query",
                        "required": false,
                        "description": "Return customers with an id greater than this.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "Page size. Default 15, maximum 50.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 15
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of customers and the next cursor.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": [
                                        {
                                            "id": 318,
                                            "first_name": "Олена",
                                            "last_name": "Коваль",
                                            "company_name": null,
                                            "email": "olena@example.com",
                                            "orders_count": 3,
                                            "created_at": "2026-09-14 11:02:40",
                                            "updated_at": "2026-10-12 14:03:11"
                                        }
                                    ],
                                    "next_cursor": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks customers:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot customers:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/customers/{id}": {
            "get": {
                "operationId": "show-customer",
                "tags": [
                    "Customers"
                ],
                "summary": "Get a customer",
                "description": "One customer account with the fields of the list, its addresses and its 20 most recent placed orders.\n\nRequires customers:read.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The customer id.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 318
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The customer.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": {
                                        "id": 318,
                                        "first_name": "Олена",
                                        "last_name": "Коваль",
                                        "company_name": null,
                                        "email": "olena@example.com",
                                        "orders_count": 3,
                                        "created_at": "2026-09-14 11:02:40",
                                        "updated_at": "2026-10-12 14:03:11",
                                        "addresses": [
                                            {
                                                "first_name": "Олена",
                                                "last_name": "Коваль",
                                                "company_name": null,
                                                "line_one": "Відділення №1",
                                                "line_two": null,
                                                "city": "Київ",
                                                "postcode": "01001",
                                                "country": "UA",
                                                "contact_email": "olena@example.com",
                                                "contact_phone": "+380671234567",
                                                "shipping_default": true
                                            }
                                        ],
                                        "recent_orders": [
                                            {
                                                "reference": "2026-001044",
                                                "status": "dispatched",
                                                "total": 214000,
                                                "currency_code": "UAH",
                                                "placed_at": "2026-10-12 14:03:11"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No customer with this id.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "not_found",
                                    "message": "not_found",
                                    "field": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks customers:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot customers:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/inventory": {
            "put": {
                "operationId": "put-inventory",
                "tags": [
                    "Inventory"
                ],
                "summary": "Set stock",
                "description": "Sets the stock of up to 100 variants at once, by SKU (case-insensitive) or by variant id — also variants made in the admin, not only those your key created. Each row is reported on its own: one unknown SKU never rejects the batch.\n\nstatus per row: updated, unchanged, not_found, or ambiguous_sku when two variants share the SKU (set it by variant_id). A change sends the inventory.updated webhook, as an edit in the admin does.\n\nRequires inventory:write.",
                "parameters": [
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "description": "A unique key for this attempt (a UUID). Repeating it returns the first response.",
                        "schema": {
                            "type": "string",
                            "maxLength": 191
                        }
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "items"
                                ],
                                "properties": {
                                    "items": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Rows of {sku or variant_id, quantity}: 1 to 100; quantity 0 to 1 000 000."
                                    }
                                }
                            },
                            "example": {
                                "items": [
                                    {
                                        "sku": "HOOD-BLK-M",
                                        "quantity": 12
                                    },
                                    {
                                        "variant_id": 4412,
                                        "quantity": 0
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "One result per row, in request order.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": [
                                        {
                                            "index": 0,
                                            "sku": "HOOD-BLK-M",
                                            "variant_id": 4410,
                                            "status": "updated",
                                            "quantity": 12
                                        },
                                        {
                                            "index": 1,
                                            "sku": null,
                                            "variant_id": 4412,
                                            "status": "not_found",
                                            "quantity": null
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks inventory:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot inventory:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/content/pages": {
            "get": {
                "operationId": "list-pages",
                "tags": [
                    "Content"
                ],
                "summary": "List pages and posts",
                "description": "Pages and blog posts of the store (system pages such as the home page are left out), with cursor pagination.\n\nRequires content:read.",
                "parameters": [
                    {
                        "name": "type",
                        "in": "query",
                        "required": false,
                        "description": "page or blog; all when left out.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "page",
                                "blog"
                            ]
                        },
                        "example": "blog"
                    },
                    {
                        "name": "cursor",
                        "in": "query",
                        "required": false,
                        "description": "Return records with an id greater than this.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "Page size. Default 15, maximum 50.",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 15
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of content and the next cursor.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": [
                                        {
                                            "id": 58,
                                            "type": "blog",
                                            "title": "Як обрати навушники",
                                            "slug": "yak-obraty-navushnyky",
                                            "published_at": "2026-10-12 09:00:00",
                                            "updated_at": "2026-10-12 08:55:00"
                                        }
                                    ],
                                    "next_cursor": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks content:read, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot content:read.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/content/pages/{external_id}": {
            "put": {
                "operationId": "upsert-page",
                "tags": [
                    "Content"
                ],
                "summary": "Create or update a draft",
                "description": "Writes a page or blog post by your id. Saving never publishes: publish it with the publish call. HTML in body is sanitized; the slug comes from slug or the title.\n\nRequires content:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your page id.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "cms-post-118"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "title"
                                ],
                                "properties": {
                                    "title": {
                                        "type": "string",
                                        "description": "Title."
                                    },
                                    "type": {
                                        "type": "string",
                                        "description": "page or blog. Default page.",
                                        "enum": [
                                            "page",
                                            "blog"
                                        ]
                                    },
                                    "slug": {
                                        "type": "string",
                                        "description": "Address part; made from the title when left out."
                                    },
                                    "body": {
                                        "type": "string",
                                        "description": "HTML of the page."
                                    }
                                }
                            },
                            "example": {
                                "type": "blog",
                                "title": "Як обрати навушники",
                                "slug": "yak-obraty-navushnyky",
                                "body": "<p>Три речі, на які варто зважати…</p>"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "The draft.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "external_id": "cms-post-118",
                                    "data": {
                                        "id": 58,
                                        "type": "blog",
                                        "title": "Як обрати навушники",
                                        "slug": "yak-obraty-navushnyky",
                                        "published_at": null,
                                        "updated_at": "2026-10-12 08:55:00"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks content:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot content:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/content/pages/{external_id}/publish": {
            "post": {
                "operationId": "publish-page",
                "tags": [
                    "Content"
                ],
                "summary": "Publish a page",
                "description": "Publishes a page or post written through this key.\n\nRequires content:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your page id.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "cms-post-118"
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "description": "A unique key for this attempt (a UUID). Repeating it returns the first response.",
                        "schema": {
                            "type": "string",
                            "maxLength": 191
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The published page.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": {
                                        "id": 58,
                                        "type": "blog",
                                        "title": "Як обрати навушники",
                                        "slug": "yak-obraty-navushnyky",
                                        "published_at": "2026-10-12 09:00:00",
                                        "updated_at": "2026-10-12 08:55:00"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No page with this external id for this key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "not_found",
                                    "message": "not_found",
                                    "field": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks content:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot content:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        },
        "/content/pages/{external_id}/unpublish": {
            "post": {
                "operationId": "unpublish-page",
                "tags": [
                    "Content"
                ],
                "summary": "Unpublish a page",
                "description": "Takes a page or post off the storefront; it stays as a draft.\n\nRequires content:write.",
                "parameters": [
                    {
                        "name": "external_id",
                        "in": "path",
                        "required": true,
                        "description": "Your page id.",
                        "schema": {
                            "type": "string"
                        },
                        "example": "cms-post-118"
                    },
                    {
                        "name": "Idempotency-Key",
                        "in": "header",
                        "required": true,
                        "description": "A unique key for this attempt (a UUID). Repeating it returns the first response.",
                        "schema": {
                            "type": "string",
                            "maxLength": 191
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The page, now a draft.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "data": {
                                        "id": 58,
                                        "type": "blog",
                                        "title": "Як обрати навушники",
                                        "slug": "yak-obraty-navushnyky",
                                        "published_at": null,
                                        "updated_at": "2026-10-12 08:55:00"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No page with this external id for this key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "not_found",
                                    "message": "not_found",
                                    "field": null
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Missing, unknown or revoked key.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "unauthenticated",
                                    "message": "Integration key is inactive.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The key lacks content:write, or the store’s plan has no API access.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "forbidden",
                                    "message": "Integration key cannot content:write.",
                                    "field": null
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is invalid; field names it.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "validation_error",
                                    "message": "name is required.",
                                    "field": "name"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "More than 60 requests a minute for this key. Wait Retry-After seconds.",
                        "content": {
                            "application/json": {
                                "example": {
                                    "code": "rate_limited",
                                    "message": "Too many integration requests.",
                                    "field": null
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "x-webhooks": {
        "order.created": {
            "description": "An order was placed (also before it is paid: bank transfer, instalments). event_id is the same on every retry: deduplicate by it. Order of events is not guaranteed: for the current state GET /orders/{reference}.",
            "example": {
                "event": "order.created",
                "event_id": "81234",
                "occurred_at": "2026-10-15T12:00:00+00:00",
                "data": {
                    "id": 1044,
                    "reference": "2026-001044",
                    "status": "awaiting-payment",
                    "total": 214000,
                    "currency_code": "UAH",
                    "placed_at": "2026-10-12 14:03:11",
                    "updated_at": "2026-10-12 16:20:45",
                    "customer": {
                        "name": "Олена Коваль",
                        "email": "olena@example.com",
                        "phone": "+380671234567",
                        "first_name": "Олена",
                        "last_name": "Коваль",
                        "customer_id": 318
                    },
                    "subtotal": 214000,
                    "shipping_total": 0,
                    "discount_total": 0,
                    "tax_total": 0,
                    "lines": [
                        {
                            "id": 5012,
                            "product_id": 12,
                            "variant_id": 15,
                            "sku": "SONAR-ANC-BLK",
                            "name": "Навушники Sonar ANC повнорозмірні",
                            "option": "Чорний · Гравіювання: Для Ані",
                            "quantity": 1,
                            "unit_price": 199000,
                            "total": 199000
                        },
                        {
                            "id": 5013,
                            "product_id": 31,
                            "variant_id": 40,
                            "sku": "CASE-01",
                            "name": "Чохол для навушників",
                            "option": null,
                            "quantity": 1,
                            "unit_price": 15000,
                            "total": 15000
                        }
                    ],
                    "shipping": {
                        "method": "Нова пошта",
                        "carrier": "nova_poshta",
                        "service_type": "branch",
                        "city_name": "Київ",
                        "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                        "delivery_point_name": "Відділення №12",
                        "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                        "address": {
                            "line_one": "Відділення №12",
                            "line_two": null,
                            "city": "Київ",
                            "postcode": null,
                            "country": "UA"
                        },
                        "method_code": "NOVA_POSHTA"
                    },
                    "payment": {
                        "method": "app:com.storeforma.wayforpay"
                    },
                    "notes": "Подзвоніть перед відправкою"
                }
            }
        },
        "order.paid": {
            "description": "The payment was confirmed by the provider or by staff. Sent together with order.created when an order is paid as it is placed. event_id is the same on every retry: deduplicate by it. Order of events is not guaranteed: for the current state GET /orders/{reference}.",
            "example": {
                "event": "order.paid",
                "event_id": "81234",
                "occurred_at": "2026-10-15T12:00:00+00:00",
                "data": {
                    "id": 1044,
                    "reference": "2026-001044",
                    "status": "payment-received",
                    "total": 214000,
                    "currency_code": "UAH",
                    "placed_at": "2026-10-12 14:03:11",
                    "updated_at": "2026-10-12 16:20:45",
                    "customer": {
                        "name": "Олена Коваль",
                        "email": "olena@example.com",
                        "phone": "+380671234567",
                        "first_name": "Олена",
                        "last_name": "Коваль",
                        "customer_id": 318
                    },
                    "subtotal": 214000,
                    "shipping_total": 0,
                    "discount_total": 0,
                    "tax_total": 0,
                    "lines": [
                        {
                            "id": 5012,
                            "product_id": 12,
                            "variant_id": 15,
                            "sku": "SONAR-ANC-BLK",
                            "name": "Навушники Sonar ANC повнорозмірні",
                            "option": "Чорний · Гравіювання: Для Ані",
                            "quantity": 1,
                            "unit_price": 199000,
                            "total": 199000
                        },
                        {
                            "id": 5013,
                            "product_id": 31,
                            "variant_id": 40,
                            "sku": "CASE-01",
                            "name": "Чохол для навушників",
                            "option": null,
                            "quantity": 1,
                            "unit_price": 15000,
                            "total": 15000
                        }
                    ],
                    "shipping": {
                        "method": "Нова пошта",
                        "carrier": "nova_poshta",
                        "service_type": "branch",
                        "city_name": "Київ",
                        "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                        "delivery_point_name": "Відділення №12",
                        "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                        "address": {
                            "line_one": "Відділення №12",
                            "line_two": null,
                            "city": "Київ",
                            "postcode": null,
                            "country": "UA"
                        },
                        "method_code": "NOVA_POSHTA"
                    },
                    "payment": {
                        "method": "app:com.storeforma.wayforpay"
                    },
                    "notes": "Подзвоніть перед відправкою"
                }
            }
        },
        "order.status_changed": {
            "description": "The fulfilment status changed (in the admin or through POST /orders/{reference}/status). event_id is the same on every retry: deduplicate by it. Order of events is not guaranteed: for the current state GET /orders/{reference}.",
            "example": {
                "event": "order.status_changed",
                "event_id": "81234",
                "occurred_at": "2026-10-15T12:00:00+00:00",
                "data": {
                    "id": 1044,
                    "reference": "2026-001044",
                    "status": "dispatched",
                    "total": 214000,
                    "currency_code": "UAH",
                    "placed_at": "2026-10-12 14:03:11",
                    "updated_at": "2026-10-12 16:20:45",
                    "customer": {
                        "name": "Олена Коваль",
                        "email": "olena@example.com",
                        "phone": "+380671234567",
                        "first_name": "Олена",
                        "last_name": "Коваль",
                        "customer_id": 318
                    },
                    "subtotal": 214000,
                    "shipping_total": 0,
                    "discount_total": 0,
                    "tax_total": 0,
                    "lines": [
                        {
                            "id": 5012,
                            "product_id": 12,
                            "variant_id": 15,
                            "sku": "SONAR-ANC-BLK",
                            "name": "Навушники Sonar ANC повнорозмірні",
                            "option": "Чорний · Гравіювання: Для Ані",
                            "quantity": 1,
                            "unit_price": 199000,
                            "total": 199000
                        },
                        {
                            "id": 5013,
                            "product_id": 31,
                            "variant_id": 40,
                            "sku": "CASE-01",
                            "name": "Чохол для навушників",
                            "option": null,
                            "quantity": 1,
                            "unit_price": 15000,
                            "total": 15000
                        }
                    ],
                    "shipping": {
                        "method": "Нова пошта",
                        "carrier": "nova_poshta",
                        "service_type": "branch",
                        "city_name": "Київ",
                        "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                        "delivery_point_name": "Відділення №12",
                        "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                        "address": {
                            "line_one": "Відділення №12",
                            "line_two": null,
                            "city": "Київ",
                            "postcode": null,
                            "country": "UA"
                        },
                        "method_code": "NOVA_POSHTA"
                    },
                    "payment": {
                        "method": "app:com.storeforma.wayforpay"
                    },
                    "notes": "Подзвоніть перед відправкою"
                }
            }
        },
        "order.cancelled": {
            "description": "The order was cancelled. event_id is the same on every retry: deduplicate by it. Order of events is not guaranteed: for the current state GET /orders/{reference}.",
            "example": {
                "event": "order.cancelled",
                "event_id": "81234",
                "occurred_at": "2026-10-15T12:00:00+00:00",
                "data": {
                    "id": 1044,
                    "reference": "2026-001044",
                    "status": "cancelled",
                    "total": 214000,
                    "currency_code": "UAH",
                    "placed_at": "2026-10-12 14:03:11",
                    "updated_at": "2026-10-12 16:20:45",
                    "customer": {
                        "name": "Олена Коваль",
                        "email": "olena@example.com",
                        "phone": "+380671234567",
                        "first_name": "Олена",
                        "last_name": "Коваль",
                        "customer_id": 318
                    },
                    "subtotal": 214000,
                    "shipping_total": 0,
                    "discount_total": 0,
                    "tax_total": 0,
                    "lines": [
                        {
                            "id": 5012,
                            "product_id": 12,
                            "variant_id": 15,
                            "sku": "SONAR-ANC-BLK",
                            "name": "Навушники Sonar ANC повнорозмірні",
                            "option": "Чорний · Гравіювання: Для Ані",
                            "quantity": 1,
                            "unit_price": 199000,
                            "total": 199000
                        },
                        {
                            "id": 5013,
                            "product_id": 31,
                            "variant_id": 40,
                            "sku": "CASE-01",
                            "name": "Чохол для навушників",
                            "option": null,
                            "quantity": 1,
                            "unit_price": 15000,
                            "total": 15000
                        }
                    ],
                    "shipping": {
                        "method": "Нова пошта",
                        "carrier": "nova_poshta",
                        "service_type": "branch",
                        "city_name": "Київ",
                        "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                        "delivery_point_name": "Відділення №12",
                        "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                        "address": {
                            "line_one": "Відділення №12",
                            "line_two": null,
                            "city": "Київ",
                            "postcode": null,
                            "country": "UA"
                        },
                        "method_code": "NOVA_POSHTA"
                    },
                    "payment": {
                        "method": "app:com.storeforma.wayforpay"
                    },
                    "notes": "Подзвоніть перед відправкою"
                }
            }
        },
        "order.refunded": {
            "description": "The provider confirmed a full refund. event_id is the same on every retry: deduplicate by it. Order of events is not guaranteed: for the current state GET /orders/{reference}.",
            "example": {
                "event": "order.refunded",
                "event_id": "81234",
                "occurred_at": "2026-10-15T12:00:00+00:00",
                "data": {
                    "id": 1044,
                    "reference": "2026-001044",
                    "status": "refunded",
                    "total": 214000,
                    "currency_code": "UAH",
                    "placed_at": "2026-10-12 14:03:11",
                    "updated_at": "2026-10-12 16:20:45",
                    "customer": {
                        "name": "Олена Коваль",
                        "email": "olena@example.com",
                        "phone": "+380671234567",
                        "first_name": "Олена",
                        "last_name": "Коваль",
                        "customer_id": 318
                    },
                    "subtotal": 214000,
                    "shipping_total": 0,
                    "discount_total": 0,
                    "tax_total": 0,
                    "lines": [
                        {
                            "id": 5012,
                            "product_id": 12,
                            "variant_id": 15,
                            "sku": "SONAR-ANC-BLK",
                            "name": "Навушники Sonar ANC повнорозмірні",
                            "option": "Чорний · Гравіювання: Для Ані",
                            "quantity": 1,
                            "unit_price": 199000,
                            "total": 199000
                        },
                        {
                            "id": 5013,
                            "product_id": 31,
                            "variant_id": 40,
                            "sku": "CASE-01",
                            "name": "Чохол для навушників",
                            "option": null,
                            "quantity": 1,
                            "unit_price": 15000,
                            "total": 15000
                        }
                    ],
                    "shipping": {
                        "method": "Нова пошта",
                        "carrier": "nova_poshta",
                        "service_type": "branch",
                        "city_name": "Київ",
                        "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
                        "delivery_point_name": "Відділення №12",
                        "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
                        "address": {
                            "line_one": "Відділення №12",
                            "line_two": null,
                            "city": "Київ",
                            "postcode": null,
                            "country": "UA"
                        },
                        "method_code": "NOVA_POSHTA"
                    },
                    "payment": {
                        "method": "app:com.storeforma.wayforpay"
                    },
                    "notes": "Подзвоніть перед відправкою"
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearer": {
                "type": "http",
                "scheme": "bearer",
                "description": "Integration key from the store admin (Settings → API keys). Its abilities decide which calls it may make."
            }
        },
        "schemas": {
            "Problem": {
                "type": "object",
                "properties": {
                    "code": {
                        "type": "string"
                    },
                    "message": {
                        "type": "string"
                    },
                    "field": {
                        "type": "string",
                        "nullable": true
                    }
                }
            }
        }
    }
}