{
    "info": {
        "_postman_id": "91f1952b-32a6-48b1-94a9-63eaf171e1d6",
        "name": "Guper API",
        "description": "Public Guper API reference. Generated from the documentation portal.",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "item": [
        {
            "name": "Catalog",
            "item": [
                {
                    "name": "Brand",
                    "item": [
                        {
                            "name": "By-entity",
                            "item": [
                                {
                                    "name": "List refs of many Brands",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand-external-ref/by-brand",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand-external-ref",
                                                "by-brand"
                                            ]
                                        },
                                        "description": "Same reverse lookup as `by-brand/{brandId}`, but for a page of entities at once:\nthe body is a JSON array of Guper ids (max 500).\n\nReturns a flat list `[{refId, source, id}]`, not grouped — `id` is the brand the\nrow belongs to. Built for the mapping grids in the panel, which paint entities x\ninterfaces and would otherwise need one call per row.\n\nIds with no mapping simply do not appear. An empty array in, an empty array out."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/brand-external-ref/by-brand",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "brand-external-ref",
                                                        "by-brand"
                                                    ]
                                                },
                                                "description": "Same reverse lookup as `by-brand/{brandId}`, but for a page of entities at once:\nthe body is a JSON array of Guper ids (max 500).\n\nReturns a flat list `[{refId, source, id}]`, not grouped — `id` is the brand the\nrow belongs to. Built for the mapping grids in the panel, which paint entities x\ninterfaces and would otherwise need one call per row.\n\nIds with no mapping simply do not appear. An empty array in, an empty array out."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\",\"id\":42},{\"refId\":\"11-2\",\"source\":\"pos\",\"id\":42},{\"refId\":\"9-22\",\"source\":\"pos\",\"id\":51}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "List refs of a Brand",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand-external-ref/by-brand/{{brandId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand-external-ref",
                                                "by-brand",
                                                "{{brandId}}"
                                            ]
                                        },
                                        "description": "Lists every external `refId` mapped to one brand, one row per `source` (interface).\n\nReverse of `/api/catalog/{interface}/brand/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the brand has no mapping. Does not 404 on an unknown id."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/brand-external-ref/by-brand/{{brandId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "brand-external-ref",
                                                        "by-brand",
                                                        "{{brandId}}"
                                                    ]
                                                },
                                                "description": "Lists every external `refId` mapped to one brand, one row per `source` (interface).\n\nReverse of `/api/catalog/{interface}/brand/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the brand has no mapping. Does not 404 on an unknown id."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\"},{\"refId\":\"11-2\",\"source\":\"pos\"}]"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "By-interface",
                            "item": [
                                {
                                    "name": "Link Brand ref to existing entity",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "brand",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Links this `refId` to an existing entity (passed by `brandId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"brandId\": 42\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "brand",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Links this `refId` to an existing entity (passed by `brandId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"brandId\": 42\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_linked\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Brand refs",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "brand"
                                            ]
                                        },
                                        "description": "Lists every external ref for `brand` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "brand"
                                                    ]
                                                },
                                                "description": "Lists every external ref for `brand` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}},{\"id\":89,\"name\":\"Adidas\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-ADIDAS-001\"}}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Brand by ref",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "brand",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "brand",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove Brand ref",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "brand",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "brand",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"success\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Bulk resolve Brand refs",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/_resolve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "brand",
                                                "_resolve"
                                            ]
                                        },
                                        "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand/_resolve",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "brand",
                                                        "_resolve"
                                                    ]
                                                },
                                                "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"VTEX-NIKE-001\":42,\"VTEX-ADIDAS-001\":89,\"FAKE-DOES-NOT-EXIST\":null}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Create or get Brand ref",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "brand"
                                            ]
                                        },
                                        "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/brand",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "brand"
                                                    ]
                                                },
                                                "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_created\":true}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Create Brand",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/brand",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "brand"
                                    ]
                                },
                                "description": "Creates a new brand under the current organization. Only `name` is accepted; the brand id is generated by the database and returned in the response.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"PoloPlay\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Brand created",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand"
                                            ]
                                        },
                                        "description": "Creates a new brand under the current organization. Only `name` is accepted; the brand id is generated by the database and returned in the response.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"PoloPlay\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"name\": \"PoloPlay\",\n    \"organization\": \"acme\",\n    \"id\": 124,\n    \"dateTime\": \"2024-08-23T20:53:41-03:00\"\n}"
                                },
                                {
                                    "name": "Missing required field `name`",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand"
                                            ]
                                        },
                                        "description": "Creates a new brand under the current organization. Only `name` is accepted; the brand id is generated by the database and returned in the response.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"PoloPlay\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Json parameters are missing\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Remove Brand",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/brand/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "brand",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Deletes a brand by id. The id goes in the URL; no body is required."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Deletes a brand by id. The id goes in the URL; no body is required."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 123,\n    \"dateTime\": \"2023-08-23T20:55:12-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Update Brand",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/brand/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "brand",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Updates an existing brand. The id goes in the URL; the body carries the fields to change. Only `name` is editable.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Alfani\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Brand updated",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates an existing brand. The id goes in the URL; the body carries the fields to change. Only `name` is editable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Alfani\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"name\": \"Alfani\",\n    \"id\": 123,\n    \"organization\": \"acme\",\n    \"dateTime\": \"2024-08-23T20:54:23-03:00\"\n}"
                                },
                                {
                                    "name": "Body is not valid JSON",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/brand/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "brand",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates an existing brand. The id goes in the URL; the body carries the fields to change. Only `name` is editable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Alfani\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Body is not a json\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Category",
                    "item": [
                        {
                            "name": "By-entity",
                            "item": [
                                {
                                    "name": "List refs of many Categories",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category-external-ref/by-category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category-external-ref",
                                                "by-category"
                                            ]
                                        },
                                        "description": "Same reverse lookup as `by-category/{categoryId}`, but for a page of entities at once:\nthe body is a JSON array of Guper ids (max 500).\n\nReturns a flat list `[{refId, source, id}]`, not grouped — `id` is the category the\nrow belongs to. Built for the mapping grids in the panel, which paint entities x\ninterfaces and would otherwise need one call per row.\n\nIds with no mapping simply do not appear. An empty array in, an empty array out."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category-external-ref/by-category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "category-external-ref",
                                                        "by-category"
                                                    ]
                                                },
                                                "description": "Same reverse lookup as `by-category/{categoryId}`, but for a page of entities at once:\nthe body is a JSON array of Guper ids (max 500).\n\nReturns a flat list `[{refId, source, id}]`, not grouped — `id` is the category the\nrow belongs to. Built for the mapping grids in the panel, which paint entities x\ninterfaces and would otherwise need one call per row.\n\nIds with no mapping simply do not appear. An empty array in, an empty array out."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\",\"id\":42},{\"refId\":\"11-2\",\"source\":\"pos\",\"id\":42},{\"refId\":\"9-22\",\"source\":\"pos\",\"id\":51}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "List refs of a Category",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category-external-ref/by-category/{{categoryId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category-external-ref",
                                                "by-category",
                                                "{{categoryId}}"
                                            ]
                                        },
                                        "description": "Lists every external `refId` mapped to one category, one row per `source` (interface).\n\nReverse of `/api/catalog/{interface}/category/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the category has no mapping. Does not 404 on an unknown id."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category-external-ref/by-category/{{categoryId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "category-external-ref",
                                                        "by-category",
                                                        "{{categoryId}}"
                                                    ]
                                                },
                                                "description": "Lists every external `refId` mapped to one category, one row per `source` (interface).\n\nReverse of `/api/catalog/{interface}/category/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the category has no mapping. Does not 404 on an unknown id."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\"},{\"refId\":\"11-2\",\"source\":\"pos\"}]"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "By-interface",
                            "item": [
                                {
                                    "name": "Link Category ref to existing entity",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "category",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Links this `refId` to an existing entity (passed by `categoryId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"categoryId\": 42\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "category",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Links this `refId` to an existing entity (passed by `categoryId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"categoryId\": 42\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_linked\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Category refs",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "category"
                                            ]
                                        },
                                        "description": "Lists every external ref for `category` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Lists every external ref for `category` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}},{\"id\":89,\"name\":\"Adidas\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-ADIDAS-001\"}}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Category by ref",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "category",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "category",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove Category ref",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "category",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "category",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"success\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Bulk resolve Category refs",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/_resolve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "category",
                                                "_resolve"
                                            ]
                                        },
                                        "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category/_resolve",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "category",
                                                        "_resolve"
                                                    ]
                                                },
                                                "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"VTEX-NIKE-001\":42,\"VTEX-ADIDAS-001\":89,\"FAKE-DOES-NOT-EXIST\":null}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Create or get Category ref",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "category"
                                            ]
                                        },
                                        "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_created\":true}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Create Category",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "category"
                                    ]
                                },
                                "description": "Creates a new category under the current organization. Categories form a tree: pass `parent` (the id of the parent category) to nest the new entry; omit it to create a root-level category.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Root-level category created",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category"
                                            ]
                                        },
                                        "description": "Creates a new category under the current organization. Categories form a tree: pass `parent` (the id of the parent category) to nest the new entry; omit it to create a root-level category.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"name\": \"Shirts\",\n    \"organization\": \"acme\",\n    \"id\": 133,\n    \"dateTime\": \"2024-08-23T20:27:39-03:00\"\n}"
                                },
                                {
                                    "name": "Child category created (with parent)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category"
                                            ]
                                        },
                                        "description": "Creates a new category under the current organization. Categories form a tree: pass `parent` (the id of the parent category) to nest the new entry; omit it to create a root-level category.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"name\": \"Polos\",\n    \"parent\": 133,\n    \"organization\": \"acme\",\n    \"id\": 139,\n    \"dateTime\": \"2024-08-23T20:31:58-03:00\"\n}"
                                },
                                {
                                    "name": "Missing required field `name`",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category"
                                            ]
                                        },
                                        "description": "Creates a new category under the current organization. Categories form a tree: pass `parent` (the id of the parent category) to nest the new entry; omit it to create a root-level category.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Json parameters are missing\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Categorys",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "category"
                                    ]
                                },
                                "description": "Returns a paginated list of categories."
                            },
                            "response": [
                                {
                                    "name": "Paginated list",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category"
                                            ]
                                        },
                                        "description": "Returns a paginated list of categories."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        { \"id\": 20, \"name\": \"Smartphones\", \"refId\": \"cat-001\" },\n        { \"id\": 21, \"name\": \"Accessories\", \"refId\": \"cat-002\" }\n    ],\n    \"total\": 2,\n    \"pagination\": { \"entries\": 20, \"currentPage\": 1, \"totalPages\": 1 }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get Category",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{refId}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "category",
                                        "{{refId}}"
                                    ]
                                },
                                "description": "### Retrieve Category Details\n\nThis endpoint retrieves the details of a specific category by providing the reference ID in the URL path.\n\n#### Request\n\n- Method: GET\n    \n- URL: `{{scheme}}://{{account}}.{{environment}}/api/catalog/category/:refId`\n    \n- Path Parameters:\n    \n    - `refId`: The reference ID of the category to retrieve."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "### Retrieve Category Details\n\nThis endpoint retrieves the details of a specific category by providing the reference ID in the URL path.\n\n#### Request\n\n- Method: GET\n    \n- URL: `{{scheme}}://{{account}}.{{environment}}/api/catalog/category/:refId`\n    \n- Path Parameters:\n    \n    - `refId`: The reference ID of the category to retrieve."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Remove Category",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "category",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Deletes a category by id. The id goes in the URL; no body is required."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": ""
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Deletes a category by id. The id goes in the URL; no body is required."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 1329,\n    \"dateTime\": \"2023-08-23T20:36:45-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Update Category",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "category",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Updates an existing category. The id goes in the URL; the body carries the fields to change. Both `name` and `parent` are editable — pass `parent` to move the category in the tree, or send `null` to detach it back to root level.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Category updated",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates an existing category. The id goes in the URL; the body carries the fields to change. Both `name` and `parent` are editable — pass `parent` to move the category in the tree, or send `null` to detach it back to root level.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"name\": \"Polos\",\n    \"parent\": 133,\n    \"id\": 139,\n    \"organization\": \"acme\",\n    \"dateTime\": \"2024-08-23T20:41:20-03:00\"\n}"
                                },
                                {
                                    "name": "Body is not valid JSON",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/category/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "category",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates an existing category. The id goes in the URL; the body carries the fields to change. Both `name` and `parent` are editable — pass `parent` to move the category in the tree, or send `null` to detach it back to root level.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Polos\",\n    \"parent\": 133\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Body is not a json\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Collection",
                    "item": [
                        {
                            "name": "SKU",
                            "item": [
                                {
                                    "name": "Map Skus to collections",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/collection/query/by/{{interface}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "collection",
                                                "query",
                                                "by",
                                                "{{interface}}"
                                            ]
                                        },
                                        "description": "Given a list of SKU IDs, returns which collections (in the given interface) each SKU belongs to.\nA SKU matches a collection when:\n- it appears as an explicit SKU in `collection_sku`,\n- it falls inside a numeric range in `collection_sku_ranges` (`sku_start` <= sku <= `sku_end`),\n- it matches a LIKE pattern in `collection_sku_pattern` (e.g. `ot%`, `%ot`, `%ot%`, case-insensitive),\n- or the collection has no SKU/range/pattern declared for that interface (empty-collection fallback: such collections are returned for every SKU).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "[\r\n    \"OT123\", \"abc\", \"550\"\r\n]",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/collection/query/by/{{interface}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "collection",
                                                        "query",
                                                        "by",
                                                        "{{interface}}"
                                                    ]
                                                },
                                                "description": "Given a list of SKU IDs, returns which collections (in the given interface) each SKU belongs to.\nA SKU matches a collection when:\n- it appears as an explicit SKU in `collection_sku`,\n- it falls inside a numeric range in `collection_sku_ranges` (`sku_start` <= sku <= `sku_end`),\n- it matches a LIKE pattern in `collection_sku_pattern` (e.g. `ot%`, `%ot`, `%ot%`, case-insensitive),\n- or the collection has no SKU/range/pattern declared for that interface (empty-collection fallback: such collections are returned for every SKU).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "[\r\n    \"OT123\", \"abc\", \"550\"\r\n]",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"OT123\": {\n        \"id\": \"OT123\",\n        \"collection\": [\n            2,\n            17\n        ]\n    },\n    \"abc\": {\n        \"id\": \"abc\",\n        \"collection\": [\n            2\n        ]\n    },\n    \"550\": {\n        \"id\": \"550\",\n        \"collection\": [\n            2,\n            9\n        ]\n    }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Collection SKUs",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Use `text/plain` — the body is a raw semicolon-separated string, not JSON."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/collection/{{id}}/skus/by/{{interface}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "collection",
                                                "{{id}}",
                                                "skus",
                                                "by",
                                                "{{interface}}"
                                            ]
                                        },
                                        "description": "Replaces the SKU set of a collection for a given interface. The body is a plain semicolon-separated string (NOT JSON). Each token is one of:\n- exact SKU: `sku-123`\n- numeric range: `start:end` (e.g. `500:600`)\n- LIKE pattern: contains `%` or `_` (e.g. `ot%`, `%ot`, `%ot%`). Patterns are stored lowercased and matched case-insensitively.\n\nToken resolution order: pattern (`%`/`_`) → range (`:`) → exact. A token containing `%` is always treated as pattern, even if it also contains `:`.\n\nThis endpoint is \"replace all\": existing SKUs/ranges/patterns of the (collection, interface) pair are deleted before the new tokens are inserted.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "ot%; %ot; sku-exato-1; 500:600",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "SKU set replaced successfully",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Use `text/plain` — the body is a raw semicolon-separated string, not JSON."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/collection/{{id}}/skus/by/{{interface}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "collection",
                                                        "{{id}}",
                                                        "skus",
                                                        "by",
                                                        "{{interface}}"
                                                    ]
                                                },
                                                "description": "Replaces the SKU set of a collection for a given interface. The body is a plain semicolon-separated string (NOT JSON). Each token is one of:\n- exact SKU: `sku-123`\n- numeric range: `start:end` (e.g. `500:600`)\n- LIKE pattern: contains `%` or `_` (e.g. `ot%`, `%ot`, `%ot%`). Patterns are stored lowercased and matched case-insensitively.\n\nToken resolution order: pattern (`%`/`_`) → range (`:`) → exact. A token containing `%` is always treated as pattern, even if it also contains `:`.\n\nThis endpoint is \"replace all\": existing SKUs/ranges/patterns of the (collection, interface) pair are deleted before the new tokens are inserted.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "ot%; %ot; sku-exato-1; 500:600",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true\n}"
                                        },
                                        {
                                            "name": "Missing collection id or interface",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Use `text/plain` — the body is a raw semicolon-separated string, not JSON."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/collection/{{id}}/skus/by/{{interface}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "collection",
                                                        "{{id}}",
                                                        "skus",
                                                        "by",
                                                        "{{interface}}"
                                                    ]
                                                },
                                                "description": "Replaces the SKU set of a collection for a given interface. The body is a plain semicolon-separated string (NOT JSON). Each token is one of:\n- exact SKU: `sku-123`\n- numeric range: `start:end` (e.g. `500:600`)\n- LIKE pattern: contains `%` or `_` (e.g. `ot%`, `%ot`, `%ot%`). Patterns are stored lowercased and matched case-insensitively.\n\nToken resolution order: pattern (`%`/`_`) → range (`:`) → exact. A token containing `%` is always treated as pattern, even if it also contains `:`.\n\nThis endpoint is \"replace all\": existing SKUs/ranges/patterns of the (collection, interface) pair are deleted before the new tokens are inserted.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "ot%; %ot; sku-exato-1; 500:600",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"error\": \"Bad Request\"\n}"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/catalog/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "catalog",
                                "ping"
                            ]
                        },
                        "description": "Resource for checking service availability"
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/catalog/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "catalog",
                                        "ping"
                                    ]
                                },
                                "description": "Resource for checking service availability"
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"account\": \"acme\",\n    \"response\": \"Server online\",\n    \"dateTime\": \"2023-08-11T13:48:50-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Seller",
                    "item": [
                        {
                            "name": "By-entity",
                            "item": [
                                {
                                    "name": "List refs of many Sellers",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/seller-external-ref/by-seller",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "seller-external-ref",
                                                "by-seller"
                                            ]
                                        },
                                        "description": "Same reverse lookup as `by-seller/{sellerId}`, but for a page of entities at once:\nthe body is a JSON array of Guper ids (max 500).\n\nReturns a flat list `[{refId, source, id}]`, not grouped — `id` is the seller the\nrow belongs to. Built for the mapping grids in the panel, which paint entities x\ninterfaces and would otherwise need one call per row.\n\nIds with no mapping simply do not appear. An empty array in, an empty array out."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/seller-external-ref/by-seller",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "seller-external-ref",
                                                        "by-seller"
                                                    ]
                                                },
                                                "description": "Same reverse lookup as `by-seller/{sellerId}`, but for a page of entities at once:\nthe body is a JSON array of Guper ids (max 500).\n\nReturns a flat list `[{refId, source, id}]`, not grouped — `id` is the seller the\nrow belongs to. Built for the mapping grids in the panel, which paint entities x\ninterfaces and would otherwise need one call per row.\n\nIds with no mapping simply do not appear. An empty array in, an empty array out."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\",\"id\":42},{\"refId\":\"11-2\",\"source\":\"pos\",\"id\":42},{\"refId\":\"9-22\",\"source\":\"pos\",\"id\":51}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "List refs of a Seller",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/seller-external-ref/by-seller/{{sellerId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "seller-external-ref",
                                                "by-seller",
                                                "{{sellerId}}"
                                            ]
                                        },
                                        "description": "Lists every external `refId` mapped to one seller, one row per `source` (interface).\n\nReverse of `/api/catalog/{interface}/seller/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the seller has no mapping. Does not 404 on an unknown id."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/seller-external-ref/by-seller/{{sellerId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "seller-external-ref",
                                                        "by-seller",
                                                        "{{sellerId}}"
                                                    ]
                                                },
                                                "description": "Lists every external `refId` mapped to one seller, one row per `source` (interface).\n\nReverse of `/api/catalog/{interface}/seller/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the seller has no mapping. Does not 404 on an unknown id."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\"},{\"refId\":\"11-2\",\"source\":\"pos\"}]"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "By-interface",
                            "item": [
                                {
                                    "name": "Link Seller ref to existing entity",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "seller",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Links this `refId` to an existing entity (passed by `sellerId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"sellerId\": 42\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "seller",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Links this `refId` to an existing entity (passed by `sellerId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"sellerId\": 42\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_linked\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Seller refs",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "seller"
                                            ]
                                        },
                                        "description": "Lists every external ref for `seller` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "seller"
                                                    ]
                                                },
                                                "description": "Lists every external ref for `seller` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}},{\"id\":89,\"name\":\"Adidas\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-ADIDAS-001\"}}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Seller by ref",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "seller",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "seller",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove Seller ref",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "seller",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "seller",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"success\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Bulk resolve Seller refs",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/_resolve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "seller",
                                                "_resolve"
                                            ]
                                        },
                                        "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller/_resolve",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "seller",
                                                        "_resolve"
                                                    ]
                                                },
                                                "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"VTEX-NIKE-001\":42,\"VTEX-ADIDAS-001\":89,\"FAKE-DOES-NOT-EXIST\":null}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Create or get Seller ref",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "catalog",
                                                "{{interface}}",
                                                "seller"
                                            ]
                                        },
                                        "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/catalog/{{interface}}/seller",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "catalog",
                                                        "{{interface}}",
                                                        "seller"
                                                    ]
                                                },
                                                "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_created\":true}"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Connect",
            "item": [
                {
                    "name": "API",
                    "item": [
                        {
                            "name": "Create Access",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/access",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "access"
                                    ]
                                },
                                "description": "Registers a new **API access** entry for the organization — an `(apiKey, apiSecret)`\npair that integrations later exchange for a session token at\n[Get token](/docs/{lang}/api-reference/connect/api/get-token).\n\nThe `apiSecret` is hashed before persistence, so the plaintext is only ever\nseen on this request — store it on your side immediately.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"identification\": \"Admin\",\n    \"apiKey\": \"acme\",\n    \"apiSecret\": \"a10b20c30\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Access created",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/access",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "access"
                                            ]
                                        },
                                        "description": "Registers a new **API access** entry for the organization — an `(apiKey, apiSecret)`\npair that integrations later exchange for a session token at\n[Get token](/docs/{lang}/api-reference/connect/api/get-token).\n\nThe `apiSecret` is hashed before persistence, so the plaintext is only ever\nseen on this request — store it on your side immediately.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"identification\": \"Admin\",\n    \"apiKey\": \"acme\",\n    \"apiSecret\": \"a10b20c30\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"account\":        \"acme\",\n    \"identification\": \"Admin\",\n    \"apiKey\":         \"acme\",\n    \"apiSecret\":      \"**************\",\n    \"dateTime\":       \"2026-05-04T13:38:24-03:00\"\n}"
                                },
                                {
                                    "name": "Body missing fields or apiKey already exists",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/access",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "access"
                                            ]
                                        },
                                        "description": "Registers a new **API access** entry for the organization — an `(apiKey, apiSecret)`\npair that integrations later exchange for a session token at\n[Get token](/docs/{lang}/api-reference/connect/api/get-token).\n\nThe `apiSecret` is hashed before persistence, so the plaintext is only ever\nseen on this request — store it on your side immediately.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"identification\": \"Admin\",\n    \"apiKey\": \"acme\",\n    \"apiSecret\": \"a10b20c30\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"duplicate\", \"message\": \"Access to acme has already been created - code: E0018\" }"
                                }
                            ]
                        },
                        {
                            "name": "Get token",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "x-guper-apikey",
                                        "value": "{{x-guper-apikey}}",
                                        "type": "text",
                                        "description": "Public identifier of your integration account (issued by Guper)."
                                    },
                                    {
                                        "key": "x-guper-apisecret",
                                        "value": "{{x-guper-apisecret}}",
                                        "type": "text",
                                        "description": "Secret value of your integration account. Treat as a password — never expose to the browser."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/token",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "token"
                                    ]
                                },
                                "description": "Issues a new access token for an integration. Uses the **API Key + API Secret**\npair issued during account setup — *not* the user `x-guper-authorization`\ntoken (this endpoint is what produces it). The returned `accessToken` is\nsent on every subsequent request as `x-guper-authorization`.\n\n**Mind `expiresIn`.** A token presented after that moment is refused with\n`401` and `Code: E0002` by every endpoint that takes\n`x-guper-authorization` — call this endpoint again to get a fresh one.\nAsking for a new token before the current one expires is fine and does not\nrevoke it.\n\nWrong credentials answer `401`. After **8 failed attempts for the same\nkey and origin IP** this endpoint answers `429` for **15 minutes**; other\ncallers of the same organization are not affected."
                            },
                            "response": [
                                {
                                    "name": "Token issued",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            },
                                            {
                                                "key": "x-guper-apikey",
                                                "value": "{{x-guper-apikey}}",
                                                "type": "text",
                                                "description": "Public identifier of your integration account (issued by Guper)."
                                            },
                                            {
                                                "key": "x-guper-apisecret",
                                                "value": "{{x-guper-apisecret}}",
                                                "type": "text",
                                                "description": "Secret value of your integration account. Treat as a password — never expose to the browser."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/token",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "token"
                                            ]
                                        },
                                        "description": "Issues a new access token for an integration. Uses the **API Key + API Secret**\npair issued during account setup — *not* the user `x-guper-authorization`\ntoken (this endpoint is what produces it). The returned `accessToken` is\nsent on every subsequent request as `x-guper-authorization`.\n\n**Mind `expiresIn`.** A token presented after that moment is refused with\n`401` and `Code: E0002` by every endpoint that takes\n`x-guper-authorization` — call this endpoint again to get a fresh one.\nAsking for a new token before the current one expires is fine and does not\nrevoke it.\n\nWrong credentials answer `401`. After **8 failed attempts for the same\nkey and origin IP** this endpoint answers `429` for **15 minutes**; other\ncallers of the same organization are not affected."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"accessToken\": \"c074cb9bd30d7b431230877facb45e0a06790e93dea6a728cef9fdaf656bf349\",\n    \"expiresIn\":   \"2023-08-11T15:13:00-03:00\",\n    \"dateTime\":    \"2023-08-11T09:13:00-03:00\"\n}"
                                },
                                {
                                    "name": "Invalid credentials",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            },
                                            {
                                                "key": "x-guper-apikey",
                                                "value": "{{x-guper-apikey}}",
                                                "type": "text",
                                                "description": "Public identifier of your integration account (issued by Guper)."
                                            },
                                            {
                                                "key": "x-guper-apisecret",
                                                "value": "{{x-guper-apisecret}}",
                                                "type": "text",
                                                "description": "Secret value of your integration account. Treat as a password — never expose to the browser."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/token",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "token"
                                            ]
                                        },
                                        "description": "Issues a new access token for an integration. Uses the **API Key + API Secret**\npair issued during account setup — *not* the user `x-guper-authorization`\ntoken (this endpoint is what produces it). The returned `accessToken` is\nsent on every subsequent request as `x-guper-authorization`.\n\n**Mind `expiresIn`.** A token presented after that moment is refused with\n`401` and `Code: E0002` by every endpoint that takes\n`x-guper-authorization` — call this endpoint again to get a fresh one.\nAsking for a new token before the current one expires is fine and does not\nrevoke it.\n\nWrong credentials answer `401`. After **8 failed attempts for the same\nkey and origin IP** this endpoint answers `429` for **15 minutes**; other\ncallers of the same organization are not affected."
                                    },
                                    "status": "Unauthorized",
                                    "code": 401,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\":   \"invalid_credentials\",\n    \"message\": \"API key or secret is invalid.\"\n}"
                                },
                                {
                                    "name": "Temporarily blocked after 8 failed attempts; try again in 15 minutes",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            },
                                            {
                                                "key": "x-guper-apikey",
                                                "value": "{{x-guper-apikey}}",
                                                "type": "text",
                                                "description": "Public identifier of your integration account (issued by Guper)."
                                            },
                                            {
                                                "key": "x-guper-apisecret",
                                                "value": "{{x-guper-apisecret}}",
                                                "type": "text",
                                                "description": "Secret value of your integration account. Treat as a password — never expose to the browser."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/token",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "token"
                                            ]
                                        },
                                        "description": "Issues a new access token for an integration. Uses the **API Key + API Secret**\npair issued during account setup — *not* the user `x-guper-authorization`\ntoken (this endpoint is what produces it). The returned `accessToken` is\nsent on every subsequent request as `x-guper-authorization`.\n\n**Mind `expiresIn`.** A token presented after that moment is refused with\n`401` and `Code: E0002` by every endpoint that takes\n`x-guper-authorization` — call this endpoint again to get a fresh one.\nAsking for a new token before the current one expires is fine and does not\nrevoke it.\n\nWrong credentials answer `401`. After **8 failed attempts for the same\nkey and origin IP** this endpoint answers `429` for **15 minutes**; other\ncallers of the same organization are not affected."
                                    },
                                    "status": "OK",
                                    "code": 429,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   429,\n    \"reason_phrase\": \"Too Many Requests\",\n    \"message\":       \"Too many failed attempts. Try again later.\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Grant Access Scope",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/accessScope",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "accessScope"
                                    ]
                                },
                                "description": "Attaches one or more **scopes** to an existing `apiKey`. A scope is the\n`service.scope` pair declared by each Guper service in its account\nconfiguration.\n\nToday every service exposes a single `all` scope — `register.all`,\n`loyalty.all`, `order.all`, `sender.all`, `catalog.all`,\n`organization.all`, `journey.all`, `media-manager.all`,\n`auditObserver.all`, `pipeline.all`, `gapp-be.all` — and `connect`\nexposes six finer ones: `connect.user`, `connect.access`, `connect.scope`,\n`connect.session`, `connect.auth` and `connect.mcp`. Finer scopes for the\nother services are added as the need appears.\n\nA request whose token belongs to a key **without** the scope the route\nrequires is refused with `403` and the response names the missing scope in\n`requiredScope`. Calls signed between Guper services do not go through\nthis check.\n\nSent scopes that don't match a known `service.scope` come back in\n`invalidScopes`; duplicate grants are silently ignored. The response\nalways reflects what was actually persisted.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"apiKey\": \"acme\",\n    \"scope\": \"[\\\"register.all\\\", \\\"loyalty.all\\\", \\\"connect.user\\\"]\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Scopes granted (with invalidScopes/errors when applicable)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/accessScope",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "accessScope"
                                            ]
                                        },
                                        "description": "Attaches one or more **scopes** to an existing `apiKey`. A scope is the\n`service.scope` pair declared by each Guper service in its account\nconfiguration.\n\nToday every service exposes a single `all` scope — `register.all`,\n`loyalty.all`, `order.all`, `sender.all`, `catalog.all`,\n`organization.all`, `journey.all`, `media-manager.all`,\n`auditObserver.all`, `pipeline.all`, `gapp-be.all` — and `connect`\nexposes six finer ones: `connect.user`, `connect.access`, `connect.scope`,\n`connect.session`, `connect.auth` and `connect.mcp`. Finer scopes for the\nother services are added as the need appears.\n\nA request whose token belongs to a key **without** the scope the route\nrequires is refused with `403` and the response names the missing scope in\n`requiredScope`. Calls signed between Guper services do not go through\nthis check.\n\nSent scopes that don't match a known `service.scope` come back in\n`invalidScopes`; duplicate grants are silently ignored. The response\nalways reflects what was actually persisted.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"apiKey\": \"acme\",\n    \"scope\": \"[\\\"register.all\\\", \\\"loyalty.all\\\", \\\"connect.user\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"access\":       \"acme\",\n    \"scopes\": [\n        { \"scope\": 1, \"access\": 11 },\n        { \"scope\": 2, \"access\": 11 }\n    ],\n    \"dateTime\":     \"2026-05-04T13:38:53-03:00\"\n}"
                                },
                                {
                                    "name": "The calling key lacks the scope the route requires",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/accessScope",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "accessScope"
                                            ]
                                        },
                                        "description": "Attaches one or more **scopes** to an existing `apiKey`. A scope is the\n`service.scope` pair declared by each Guper service in its account\nconfiguration.\n\nToday every service exposes a single `all` scope — `register.all`,\n`loyalty.all`, `order.all`, `sender.all`, `catalog.all`,\n`organization.all`, `journey.all`, `media-manager.all`,\n`auditObserver.all`, `pipeline.all`, `gapp-be.all` — and `connect`\nexposes six finer ones: `connect.user`, `connect.access`, `connect.scope`,\n`connect.session`, `connect.auth` and `connect.mcp`. Finer scopes for the\nother services are added as the need appears.\n\nA request whose token belongs to a key **without** the scope the route\nrequires is refused with `403` and the response names the missing scope in\n`requiredScope`. Calls signed between Guper services do not go through\nthis check.\n\nSent scopes that don't match a known `service.scope` come back in\n`invalidScopes`; duplicate grants are silently ignored. The response\nalways reflects what was actually persisted.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"apiKey\": \"acme\",\n    \"scope\": \"[\\\"register.all\\\", \\\"loyalty.all\\\", \\\"connect.user\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Forbidden",
                                    "code": 403,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":    403,\n    \"reason_phrase\":  \"Forbidden\",\n    \"message\":        \"Scope required\",\n    \"requiredScope\":  \"connect.scope\"\n}"
                                },
                                {
                                    "name": "apiKey not registered",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/accessScope",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "accessScope"
                                            ]
                                        },
                                        "description": "Attaches one or more **scopes** to an existing `apiKey`. A scope is the\n`service.scope` pair declared by each Guper service in its account\nconfiguration.\n\nToday every service exposes a single `all` scope — `register.all`,\n`loyalty.all`, `order.all`, `sender.all`, `catalog.all`,\n`organization.all`, `journey.all`, `media-manager.all`,\n`auditObserver.all`, `pipeline.all`, `gapp-be.all` — and `connect`\nexposes six finer ones: `connect.user`, `connect.access`, `connect.scope`,\n`connect.session`, `connect.auth` and `connect.mcp`. Finer scopes for the\nother services are added as the need appears.\n\nA request whose token belongs to a key **without** the scope the route\nrequires is refused with `403` and the response names the missing scope in\n`requiredScope`. Calls signed between Guper services do not go through\nthis check.\n\nSent scopes that don't match a known `service.scope` come back in\n`invalidScopes`; duplicate grants are silently ignored. The response\nalways reflects what was actually persisted.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"apiKey\": \"acme\",\n    \"scope\": \"[\\\"register.all\\\", \\\"loyalty.all\\\", \\\"connect.user\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"not_found\", \"message\": \"Access not found for apiKey\" }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Password Reset",
                    "item": [
                        {
                            "name": "Confirm Password Reset",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/confirm",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "password-reset",
                                        "confirm"
                                    ]
                                },
                                "description": "Confirms a password-reset request by consuming the token and setting a new\npassword.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request step. The verified `user-agent`\n**must match** the origin that created the reset request — this is the\n**origin lock**. A token issued by `admin` cannot be confirmed by\n`storemanager`, even with a valid signature.\n\n**Token rules:**\n- Single-use — once confirmed, the token is marked `used` and cannot be\n  redeemed again.\n- Expires after **1 hour** from creation.\n- Any pending tokens for the same `(organization, login)` are superseded\n  when a new request is created.\n\n**Password history:** The new password is checked against the user's\n**current password** and their **last 10 password hashes**. If the password\nhas been used before, the request is rejected with HTTP 400.\n\nOn success, the user's password is updated, brute-force login attempt\nrecords are cleared, and the token is marked as used.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"password\": \"NewSecurePass123!\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Password changed successfully",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "confirm"
                                            ]
                                        },
                                        "description": "Confirms a password-reset request by consuming the token and setting a new\npassword.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request step. The verified `user-agent`\n**must match** the origin that created the reset request — this is the\n**origin lock**. A token issued by `admin` cannot be confirmed by\n`storemanager`, even with a valid signature.\n\n**Token rules:**\n- Single-use — once confirmed, the token is marked `used` and cannot be\n  redeemed again.\n- Expires after **1 hour** from creation.\n- Any pending tokens for the same `(organization, login)` are superseded\n  when a new request is created.\n\n**Password history:** The new password is checked against the user's\n**current password** and their **last 10 password hashes**. If the password\nhas been used before, the request is rejected with HTTP 400.\n\nOn success, the user's password is updated, brute-force login attempt\nrecords are cleared, and the token is marked as used.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"password\": \"NewSecurePass123!\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"success\": true\n}"
                                },
                                {
                                    "name": "Invalid or expired token",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "confirm"
                                            ]
                                        },
                                        "description": "Confirms a password-reset request by consuming the token and setting a new\npassword.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request step. The verified `user-agent`\n**must match** the origin that created the reset request — this is the\n**origin lock**. A token issued by `admin` cannot be confirmed by\n`storemanager`, even with a valid signature.\n\n**Token rules:**\n- Single-use — once confirmed, the token is marked `used` and cannot be\n  redeemed again.\n- Expires after **1 hour** from creation.\n- Any pending tokens for the same `(organization, login)` are superseded\n  when a new request is created.\n\n**Password history:** The new password is checked against the user's\n**current password** and their **last 10 password hashes**. If the password\nhas been used before, the request is rejected with HTTP 400.\n\nOn success, the user's password is updated, brute-force login attempt\nrecords are cleared, and the token is marked as used.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"password\": \"NewSecurePass123!\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   400,\n    \"reason_phrase\": \"Invalid or expired token\"\n}"
                                },
                                {
                                    "name": "Password too short (minimum 8 characters)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "confirm"
                                            ]
                                        },
                                        "description": "Confirms a password-reset request by consuming the token and setting a new\npassword.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request step. The verified `user-agent`\n**must match** the origin that created the reset request — this is the\n**origin lock**. A token issued by `admin` cannot be confirmed by\n`storemanager`, even with a valid signature.\n\n**Token rules:**\n- Single-use — once confirmed, the token is marked `used` and cannot be\n  redeemed again.\n- Expires after **1 hour** from creation.\n- Any pending tokens for the same `(organization, login)` are superseded\n  when a new request is created.\n\n**Password history:** The new password is checked against the user's\n**current password** and their **last 10 password hashes**. If the password\nhas been used before, the request is rejected with HTTP 400.\n\nOn success, the user's password is updated, brute-force login attempt\nrecords are cleared, and the token is marked as used.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"password\": \"NewSecurePass123!\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   400,\n    \"reason_phrase\": \"Password must be at least 8 characters\"\n}"
                                },
                                {
                                    "name": "Password reused (matches current or one of last 10)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "confirm"
                                            ]
                                        },
                                        "description": "Confirms a password-reset request by consuming the token and setting a new\npassword.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request step. The verified `user-agent`\n**must match** the origin that created the reset request — this is the\n**origin lock**. A token issued by `admin` cannot be confirmed by\n`storemanager`, even with a valid signature.\n\n**Token rules:**\n- Single-use — once confirmed, the token is marked `used` and cannot be\n  redeemed again.\n- Expires after **1 hour** from creation.\n- Any pending tokens for the same `(organization, login)` are superseded\n  when a new request is created.\n\n**Password history:** The new password is checked against the user's\n**current password** and their **last 10 password hashes**. If the password\nhas been used before, the request is rejected with HTTP 400.\n\nOn success, the user's password is updated, brute-force login attempt\nrecords are cleared, and the token is marked as used.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"password\": \"NewSecurePass123!\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   400,\n    \"reason_phrase\": \"This password has been used before. Please choose a different one\"\n}"
                                },
                                {
                                    "name": "Origin mismatch (confirming system differs from requesting system)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "confirm"
                                            ]
                                        },
                                        "description": "Confirms a password-reset request by consuming the token and setting a new\npassword.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request step. The verified `user-agent`\n**must match** the origin that created the reset request — this is the\n**origin lock**. A token issued by `admin` cannot be confirmed by\n`storemanager`, even with a valid signature.\n\n**Token rules:**\n- Single-use — once confirmed, the token is marked `used` and cannot be\n  redeemed again.\n- Expires after **1 hour** from creation.\n- Any pending tokens for the same `(organization, login)` are superseded\n  when a new request is created.\n\n**Password history:** The new password is checked against the user's\n**current password** and their **last 10 password hashes**. If the password\nhas been used before, the request is rejected with HTTP 400.\n\nOn success, the user's password is updated, brute-force login attempt\nrecords are cleared, and the token is marked as used.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"password\": \"NewSecurePass123!\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Forbidden",
                                    "code": 403,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   403,\n    \"reason_phrase\": \"Origin mismatch\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Request Password Reset",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/request",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "password-reset",
                                        "request"
                                    ]
                                },
                                "description": "Initiates a password-reset flow for a user in the organization.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nnot a user token — because the user requesting a reset is not logged in.\nThe `user-agent` header identifies the calling system (e.g. `admin`,\n`storemanager`) and is cryptographically verified against its public key\nin `etc/keys/{user-agent}.pem`.\n\nThe verified `user-agent` is stored as the request's **origin**. Only the\nsame origin can later confirm the reset — this is the **origin lock**,\nwhich prevents a token issued by one system from being redeemed by another.\n\n**Anti-enumeration:** When the login does not exist, the endpoint returns\n`{ \"requested\": true }` without `token` or `personId`. The caller cannot\ndistinguish this from a successful request and should always show a generic\n\"check your email\" message to the end user.\n\n**Cooldown:** A 5-minute cooldown is enforced per `(organization, login)`.\nA second request within the window returns HTTP 429.\n\nThe caller is responsible for delivering the token to the user (e-mail,\nWhatsApp, etc.) — Connect generates and validates the token but does not\nsend any notification.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"login\": \"maria.silva@company.com\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "User exists — token generated",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/request",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "request"
                                            ]
                                        },
                                        "description": "Initiates a password-reset flow for a user in the organization.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nnot a user token — because the user requesting a reset is not logged in.\nThe `user-agent` header identifies the calling system (e.g. `admin`,\n`storemanager`) and is cryptographically verified against its public key\nin `etc/keys/{user-agent}.pem`.\n\nThe verified `user-agent` is stored as the request's **origin**. Only the\nsame origin can later confirm the reset — this is the **origin lock**,\nwhich prevents a token issued by one system from being redeemed by another.\n\n**Anti-enumeration:** When the login does not exist, the endpoint returns\n`{ \"requested\": true }` without `token` or `personId`. The caller cannot\ndistinguish this from a successful request and should always show a generic\n\"check your email\" message to the end user.\n\n**Cooldown:** A 5-minute cooldown is enforced per `(organization, login)`.\nA second request within the window returns HTTP 429.\n\nThe caller is responsible for delivering the token to the user (e-mail,\nWhatsApp, etc.) — Connect generates and validates the token but does not\nsend any notification.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"maria.silva@company.com\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"requested\": true,\n    \"token\":     \"a1b2c3d4e5f6...64 hex characters\",\n    \"personId\":  4399137,\n    \"login\":     \"maria.silva@company.com\"\n}"
                                },
                                {
                                    "name": "User does not exist (anti-enumeration — same shape, no token)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/request",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "request"
                                            ]
                                        },
                                        "description": "Initiates a password-reset flow for a user in the organization.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nnot a user token — because the user requesting a reset is not logged in.\nThe `user-agent` header identifies the calling system (e.g. `admin`,\n`storemanager`) and is cryptographically verified against its public key\nin `etc/keys/{user-agent}.pem`.\n\nThe verified `user-agent` is stored as the request's **origin**. Only the\nsame origin can later confirm the reset — this is the **origin lock**,\nwhich prevents a token issued by one system from being redeemed by another.\n\n**Anti-enumeration:** When the login does not exist, the endpoint returns\n`{ \"requested\": true }` without `token` or `personId`. The caller cannot\ndistinguish this from a successful request and should always show a generic\n\"check your email\" message to the end user.\n\n**Cooldown:** A 5-minute cooldown is enforced per `(organization, login)`.\nA second request within the window returns HTTP 429.\n\nThe caller is responsible for delivering the token to the user (e-mail,\nWhatsApp, etc.) — Connect generates and validates the token but does not\nsend any notification.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"maria.silva@company.com\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"requested\": true\n}"
                                },
                                {
                                    "name": "Cooldown active (less than 5 minutes since last request for this login)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/request",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "request"
                                            ]
                                        },
                                        "description": "Initiates a password-reset flow for a user in the organization.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nnot a user token — because the user requesting a reset is not logged in.\nThe `user-agent` header identifies the calling system (e.g. `admin`,\n`storemanager`) and is cryptographically verified against its public key\nin `etc/keys/{user-agent}.pem`.\n\nThe verified `user-agent` is stored as the request's **origin**. Only the\nsame origin can later confirm the reset — this is the **origin lock**,\nwhich prevents a token issued by one system from being redeemed by another.\n\n**Anti-enumeration:** When the login does not exist, the endpoint returns\n`{ \"requested\": true }` without `token` or `personId`. The caller cannot\ndistinguish this from a successful request and should always show a generic\n\"check your email\" message to the end user.\n\n**Cooldown:** A 5-minute cooldown is enforced per `(organization, login)`.\nA second request within the window returns HTTP 429.\n\nThe caller is responsible for delivering the token to the user (e-mail,\nWhatsApp, etc.) — Connect generates and validates the token but does not\nsend any notification.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"maria.silva@company.com\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 429,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   429,\n    \"reason_phrase\": \"Please wait before requesting another reset\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Validate Password Reset Token",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/validate",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "password-reset",
                                        "validate"
                                    ]
                                },
                                "description": "Validates a password-reset token without consuming it.\n\nThis is a **pre-flight check** — the caller uses it to decide what to show\nthe user before they type a new password. The token remains `pending` and\ncan still be confirmed afterwards.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request and confirm steps.\n\nThe endpoint checks, in order:\n1. **Existence** — the SHA-256 hash of the raw token must match a row in\n   `password_reset_request`.\n2. **Organization** — the row must belong to the current organization.\n3. **Status** — `used` and `superseded` tokens are rejected with a specific\n   reason so the UI can show an appropriate message.\n4. **Expiration** — tokens older than 1 hour are rejected as `expired`.\n\nIf all checks pass, the response is `{ \"valid\": true }`. Otherwise,\n`{ \"valid\": false, \"reason\": \"...\" }` with one of the reason codes below.\n\n**Reason codes:**\n| Code | Meaning |\n|------|---------|\n| `not_found` | Token does not exist or belongs to another organization |\n| `used` | Token was already consumed by a confirm call |\n| `superseded` | A newer reset was requested for the same login |\n| `expired` | Token is older than 1 hour |",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Token is valid and can be confirmed",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/validate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "validate"
                                            ]
                                        },
                                        "description": "Validates a password-reset token without consuming it.\n\nThis is a **pre-flight check** — the caller uses it to decide what to show\nthe user before they type a new password. The token remains `pending` and\ncan still be confirmed afterwards.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request and confirm steps.\n\nThe endpoint checks, in order:\n1. **Existence** — the SHA-256 hash of the raw token must match a row in\n   `password_reset_request`.\n2. **Organization** — the row must belong to the current organization.\n3. **Status** — `used` and `superseded` tokens are rejected with a specific\n   reason so the UI can show an appropriate message.\n4. **Expiration** — tokens older than 1 hour are rejected as `expired`.\n\nIf all checks pass, the response is `{ \"valid\": true }`. Otherwise,\n`{ \"valid\": false, \"reason\": \"...\" }` with one of the reason codes below.\n\n**Reason codes:**\n| Code | Meaning |\n|------|---------|\n| `not_found` | Token does not exist or belongs to another organization |\n| `used` | Token was already consumed by a confirm call |\n| `superseded` | A newer reset was requested for the same login |\n| `expired` | Token is older than 1 hour |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"valid\": true\n}"
                                },
                                {
                                    "name": "Token not found or belongs to another organization",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/validate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "validate"
                                            ]
                                        },
                                        "description": "Validates a password-reset token without consuming it.\n\nThis is a **pre-flight check** — the caller uses it to decide what to show\nthe user before they type a new password. The token remains `pending` and\ncan still be confirmed afterwards.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request and confirm steps.\n\nThe endpoint checks, in order:\n1. **Existence** — the SHA-256 hash of the raw token must match a row in\n   `password_reset_request`.\n2. **Organization** — the row must belong to the current organization.\n3. **Status** — `used` and `superseded` tokens are rejected with a specific\n   reason so the UI can show an appropriate message.\n4. **Expiration** — tokens older than 1 hour are rejected as `expired`.\n\nIf all checks pass, the response is `{ \"valid\": true }`. Otherwise,\n`{ \"valid\": false, \"reason\": \"...\" }` with one of the reason codes below.\n\n**Reason codes:**\n| Code | Meaning |\n|------|---------|\n| `not_found` | Token does not exist or belongs to another organization |\n| `used` | Token was already consumed by a confirm call |\n| `superseded` | A newer reset was requested for the same login |\n| `expired` | Token is older than 1 hour |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"valid\":  false,\n    \"reason\": \"not_found\"\n}"
                                },
                                {
                                    "name": "Token already used",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/validate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "validate"
                                            ]
                                        },
                                        "description": "Validates a password-reset token without consuming it.\n\nThis is a **pre-flight check** — the caller uses it to decide what to show\nthe user before they type a new password. The token remains `pending` and\ncan still be confirmed afterwards.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request and confirm steps.\n\nThe endpoint checks, in order:\n1. **Existence** — the SHA-256 hash of the raw token must match a row in\n   `password_reset_request`.\n2. **Organization** — the row must belong to the current organization.\n3. **Status** — `used` and `superseded` tokens are rejected with a specific\n   reason so the UI can show an appropriate message.\n4. **Expiration** — tokens older than 1 hour are rejected as `expired`.\n\nIf all checks pass, the response is `{ \"valid\": true }`. Otherwise,\n`{ \"valid\": false, \"reason\": \"...\" }` with one of the reason codes below.\n\n**Reason codes:**\n| Code | Meaning |\n|------|---------|\n| `not_found` | Token does not exist or belongs to another organization |\n| `used` | Token was already consumed by a confirm call |\n| `superseded` | A newer reset was requested for the same login |\n| `expired` | Token is older than 1 hour |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"valid\":  false,\n    \"reason\": \"used\"\n}"
                                },
                                {
                                    "name": "Token superseded by a newer request",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/validate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "validate"
                                            ]
                                        },
                                        "description": "Validates a password-reset token without consuming it.\n\nThis is a **pre-flight check** — the caller uses it to decide what to show\nthe user before they type a new password. The token remains `pending` and\ncan still be confirmed afterwards.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request and confirm steps.\n\nThe endpoint checks, in order:\n1. **Existence** — the SHA-256 hash of the raw token must match a row in\n   `password_reset_request`.\n2. **Organization** — the row must belong to the current organization.\n3. **Status** — `used` and `superseded` tokens are rejected with a specific\n   reason so the UI can show an appropriate message.\n4. **Expiration** — tokens older than 1 hour are rejected as `expired`.\n\nIf all checks pass, the response is `{ \"valid\": true }`. Otherwise,\n`{ \"valid\": false, \"reason\": \"...\" }` with one of the reason codes below.\n\n**Reason codes:**\n| Code | Meaning |\n|------|---------|\n| `not_found` | Token does not exist or belongs to another organization |\n| `used` | Token was already consumed by a confirm call |\n| `superseded` | A newer reset was requested for the same login |\n| `expired` | Token is older than 1 hour |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"valid\":  false,\n    \"reason\": \"superseded\"\n}"
                                },
                                {
                                    "name": "Token expired (older than 1 hour)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/password-reset/validate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "password-reset",
                                                "validate"
                                            ]
                                        },
                                        "description": "Validates a password-reset token without consuming it.\n\nThis is a **pre-flight check** — the caller uses it to decide what to show\nthe user before they type a new password. The token remains `pending` and\ncan still be confirmed afterwards.\n\nThe caller authenticates via **RSA signature** (OriginValidation middleware),\nthe same mechanism used in the request and confirm steps.\n\nThe endpoint checks, in order:\n1. **Existence** — the SHA-256 hash of the raw token must match a row in\n   `password_reset_request`.\n2. **Organization** — the row must belong to the current organization.\n3. **Status** — `used` and `superseded` tokens are rejected with a specific\n   reason so the UI can show an appropriate message.\n4. **Expiration** — tokens older than 1 hour are rejected as `expired`.\n\nIf all checks pass, the response is `{ \"valid\": true }`. Otherwise,\n`{ \"valid\": false, \"reason\": \"...\" }` with one of the reason codes below.\n\n**Reason codes:**\n| Code | Meaning |\n|------|---------|\n| `not_found` | Token does not exist or belongs to another organization |\n| `used` | Token was already consumed by a confirm call |\n| `superseded` | A newer reset was requested for the same login |\n| `expired` | Token is older than 1 hour |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"token\": \"a1b2c3d4e5f6...64 hex characters\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"valid\":  false,\n    \"reason\": \"expired\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/connect/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "connect",
                                "ping"
                            ]
                        },
                        "description": "Resource for checking service availability"
                    },
                    "response": [
                        {
                            "name": "Successful Response",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "ping"
                                    ]
                                },
                                "description": "Resource for checking service availability"
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"account\": \"acme\",\n    \"response\": \"Server online\",\n    \"dateTime\": \"2023-08-09T22:45:08-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Proof of Work",
                    "item": [
                        {
                            "name": "Generate challenge — Private",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/pow/challenge",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "pow",
                                        "challenge"
                                    ]
                                },
                                "description": "Called by internal services (Admin panel, other microservices) using RSA signature authentication.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"login\": \"maria.silva\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Challenge generated successfully.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/pow/challenge",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "pow",
                                                "challenge"
                                            ]
                                        },
                                        "description": "Called by internal services (Admin panel, other microservices) using RSA signature authentication.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"maria.silva\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"challenge\": \"a1b2c3d4e5f6...64 hex characters\",\n    \"target\": \"0000ffffffffffff...64 hex characters\"\n}"
                                },
                                {
                                    "name": "Missing required field.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/pow/challenge",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "pow",
                                                "challenge"
                                            ]
                                        },
                                        "description": "Called by internal services (Admin panel, other microservices) using RSA signature authentication.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"maria.silva\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Missing required field: login\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "User",
                    "item": [
                        {
                            "name": "Auth",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/auth",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "auth"
                                    ]
                                },
                                "description": "Authenticates a user by `login` + `password` and returns the matching\nperson identity (`personId`, `type`).\n\nOptionally accepts a Proof of Work `challenge` and `nonce` obtained from the\n[Generate challenge](/docs/{lang}/api-reference/connect/pow/challenge) endpoint.\nWhen provided, the server validates that SHA-256(challenge + nonce) <= target before\nchecking credentials. This prevents brute-force attacks by requiring computational\nwork before each login attempt.\n\n**Important:** The `challenge` and `nonce` fields are currently optional for\nbackward compatibility. They will become **required** in a future release.\nAll clients should integrate the Proof of Work flow as soon as possible.\n\nWrong credentials always answer the same `401` — the response never says\nwhether the login exists. After **8 failed attempts for the same login**\nthe endpoint answers `429` and stops checking the password for\n**15 minutes**; a successful sign-in clears the counter.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"login\": \"tintin\",\n    \"password\": \"a10b20c30\",\n    \"challenge\": \"a1b2c3d4...64 hex chars\",\n    \"nonce\": \"48293\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Successful Response",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/auth",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "auth"
                                            ]
                                        },
                                        "description": "Authenticates a user by `login` + `password` and returns the matching\nperson identity (`personId`, `type`).\n\nOptionally accepts a Proof of Work `challenge` and `nonce` obtained from the\n[Generate challenge](/docs/{lang}/api-reference/connect/pow/challenge) endpoint.\nWhen provided, the server validates that SHA-256(challenge + nonce) <= target before\nchecking credentials. This prevents brute-force attacks by requiring computational\nwork before each login attempt.\n\n**Important:** The `challenge` and `nonce` fields are currently optional for\nbackward compatibility. They will become **required** in a future release.\nAll clients should integrate the Proof of Work flow as soon as possible.\n\nWrong credentials always answer the same `401` — the response never says\nwhether the login exists. After **8 failed attempts for the same login**\nthe endpoint answers `429` and stops checking the password for\n**15 minutes**; a successful sign-in clears the counter.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"tintin\",\n    \"password\": \"a10b20c30\",\n    \"challenge\": \"a1b2c3d4...64 hex chars\",\n    \"nonce\": \"48293\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"personId\": 44,\n    \"type\": \"user\",\n    \"dateTime\": \"2023-08-24T17:13:52-03:00\"\n}"
                                },
                                {
                                    "name": "Proof of Work invalid or expired.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/auth",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "auth"
                                            ]
                                        },
                                        "description": "Authenticates a user by `login` + `password` and returns the matching\nperson identity (`personId`, `type`).\n\nOptionally accepts a Proof of Work `challenge` and `nonce` obtained from the\n[Generate challenge](/docs/{lang}/api-reference/connect/pow/challenge) endpoint.\nWhen provided, the server validates that SHA-256(challenge + nonce) <= target before\nchecking credentials. This prevents brute-force attacks by requiring computational\nwork before each login attempt.\n\n**Important:** The `challenge` and `nonce` fields are currently optional for\nbackward compatibility. They will become **required** in a future release.\nAll clients should integrate the Proof of Work flow as soon as possible.\n\nWrong credentials always answer the same `401` — the response never says\nwhether the login exists. After **8 failed attempts for the same login**\nthe endpoint answers `429` and stops checking the password for\n**15 minutes**; a successful sign-in clears the counter.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"tintin\",\n    \"password\": \"a10b20c30\",\n    \"challenge\": \"a1b2c3d4...64 hex chars\",\n    \"nonce\": \"48293\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Challenge invalid or expired\"\n}"
                                },
                                {
                                    "name": "Login or password invalid (same answer for both)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/auth",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "auth"
                                            ]
                                        },
                                        "description": "Authenticates a user by `login` + `password` and returns the matching\nperson identity (`personId`, `type`).\n\nOptionally accepts a Proof of Work `challenge` and `nonce` obtained from the\n[Generate challenge](/docs/{lang}/api-reference/connect/pow/challenge) endpoint.\nWhen provided, the server validates that SHA-256(challenge + nonce) <= target before\nchecking credentials. This prevents brute-force attacks by requiring computational\nwork before each login attempt.\n\n**Important:** The `challenge` and `nonce` fields are currently optional for\nbackward compatibility. They will become **required** in a future release.\nAll clients should integrate the Proof of Work flow as soon as possible.\n\nWrong credentials always answer the same `401` — the response never says\nwhether the login exists. After **8 failed attempts for the same login**\nthe endpoint answers `429` and stops checking the password for\n**15 minutes**; a successful sign-in clears the counter.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"tintin\",\n    \"password\": \"a10b20c30\",\n    \"challenge\": \"a1b2c3d4...64 hex chars\",\n    \"nonce\": \"48293\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Unauthorized",
                                    "code": 401,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   401,\n    \"reason_phrase\": \"Unauthorized\",\n    \"message\":       \"Auth unauthorized\"\n}"
                                },
                                {
                                    "name": "Temporarily blocked after 8 failed attempts; try again in 15 minutes",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/auth",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "auth"
                                            ]
                                        },
                                        "description": "Authenticates a user by `login` + `password` and returns the matching\nperson identity (`personId`, `type`).\n\nOptionally accepts a Proof of Work `challenge` and `nonce` obtained from the\n[Generate challenge](/docs/{lang}/api-reference/connect/pow/challenge) endpoint.\nWhen provided, the server validates that SHA-256(challenge + nonce) <= target before\nchecking credentials. This prevents brute-force attacks by requiring computational\nwork before each login attempt.\n\n**Important:** The `challenge` and `nonce` fields are currently optional for\nbackward compatibility. They will become **required** in a future release.\nAll clients should integrate the Proof of Work flow as soon as possible.\n\nWrong credentials always answer the same `401` — the response never says\nwhether the login exists. After **8 failed attempts for the same login**\nthe endpoint answers `429` and stops checking the password for\n**15 minutes**; a successful sign-in clears the counter.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"login\": \"tintin\",\n    \"password\": \"a10b20c30\",\n    \"challenge\": \"a1b2c3d4...64 hex chars\",\n    \"nonce\": \"48293\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 429,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   429,\n    \"reason_phrase\": \"Too Many Requests\",\n    \"message\":       \"Too many failed attempts. Try again later.\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Check Login Exists",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/user/by-login",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "user",
                                        "by-login"
                                    ]
                                },
                                "description": "Checks whether a login (e-mail) already exists for the organization. Strict match on (organization, login) — the unique key of a connect user, without the dev fallback. Used to validate user creation before creating the person, avoiding an orphan person when the e-mail is already in use as a login."
                            },
                            "response": [
                                {
                                    "name": "OK. `exists` is true when a user with this login already exists in the organization; `personId` is the owner of the login (null when it does not exist).",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user/by-login",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user",
                                                "by-login"
                                            ]
                                        },
                                        "description": "Checks whether a login (e-mail) already exists for the organization. Strict match on (organization, login) — the unique key of a connect user, without the dev fallback. Used to validate user creation before creating the person, avoiding an orphan person when the e-mail is already in use as a login."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"login\": \"maria.silva@example.com\",\n    \"exists\": true,\n    \"personId\": 44\n}"
                                },
                                {
                                    "name": "Bad Request. The `login` query parameter is missing.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user/by-login",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user",
                                                "by-login"
                                            ]
                                        },
                                        "description": "Checks whether a login (e-mail) already exists for the organization. Strict match on (organization, login) — the unique key of a connect user, without the dev fallback. Used to validate user creation before creating the person, avoiding an orphan person when the e-mail is already in use as a login."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\": 400,\n    \"reason_phrase\": \"The 'login' parameter is required\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Create User",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "user"
                                    ]
                                },
                                "description": "Wires Connect login credentials (`login` + `password`) to an existing\nperson registered in Register.\n\nThis is the **second step** of the user-onboarding flow. The first step is to\nissue an invite token for that person at\n[Create invite](/docs/{lang}/api-reference/register/person/invite) — the token\nis delivered to the new user (e-mail link, magic link, etc.) and must be\nposted back here together with the credentials.\n\nConnect decrypts the invite token with its private key, verifies the\norganization and `personId` it carries, and only then writes the User\nrecord. The `personId` of the returned User equals the `idPerson` used in\nthe invite — that's the binding between the two services.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"inviteToken\": \"<inviteToken>\",\n    \"login\": \"maria.silva\",\n    \"password\": \"S3cretPass!\",\n    \"type\": \"user\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "User created",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Wires Connect login credentials (`login` + `password`) to an existing\nperson registered in Register.\n\nThis is the **second step** of the user-onboarding flow. The first step is to\nissue an invite token for that person at\n[Create invite](/docs/{lang}/api-reference/register/person/invite) — the token\nis delivered to the new user (e-mail link, magic link, etc.) and must be\nposted back here together with the credentials.\n\nConnect decrypts the invite token with its private key, verifies the\norganization and `personId` it carries, and only then writes the User\nrecord. The `personId` of the returned User equals the `idPerson` used in\nthe invite — that's the binding between the two services.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"inviteToken\": \"<inviteToken>\",\n    \"login\": \"maria.silva\",\n    \"password\": \"S3cretPass!\",\n    \"type\": \"user\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"login\":        \"maria.silva\",\n    \"type\":         \"user\",\n    \"personId\":     44,\n    \"pass\":         \"**************\",\n    \"dateTime\":     \"2026-05-01T12:34:56-03:00\"\n}"
                                },
                                {
                                    "name": "Token is for a different organization",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Wires Connect login credentials (`login` + `password`) to an existing\nperson registered in Register.\n\nThis is the **second step** of the user-onboarding flow. The first step is to\nissue an invite token for that person at\n[Create invite](/docs/{lang}/api-reference/register/person/invite) — the token\nis delivered to the new user (e-mail link, magic link, etc.) and must be\nposted back here together with the credentials.\n\nConnect decrypts the invite token with its private key, verifies the\norganization and `personId` it carries, and only then writes the User\nrecord. The `personId` of the returned User equals the `idPerson` used in\nthe invite — that's the binding between the two services.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"inviteToken\": \"<inviteToken>\",\n    \"login\": \"maria.silva\",\n    \"password\": \"S3cretPass!\",\n    \"type\": \"user\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"forbidden\", \"message\": \"You don't have permission to create a user for this organization\" }"
                                },
                                {
                                    "name": "Login already exists",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Wires Connect login credentials (`login` + `password`) to an existing\nperson registered in Register.\n\nThis is the **second step** of the user-onboarding flow. The first step is to\nissue an invite token for that person at\n[Create invite](/docs/{lang}/api-reference/register/person/invite) — the token\nis delivered to the new user (e-mail link, magic link, etc.) and must be\nposted back here together with the credentials.\n\nConnect decrypts the invite token with its private key, verifies the\norganization and `personId` it carries, and only then writes the User\nrecord. The `personId` of the returned User equals the `idPerson` used in\nthe invite — that's the binding between the two services.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"inviteToken\": \"<inviteToken>\",\n    \"login\": \"maria.silva\",\n    \"password\": \"S3cretPass!\",\n    \"type\": \"user\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"duplicate\", \"message\": \"Access to maria.silva has already been created\" }"
                                }
                            ]
                        },
                        {
                            "name": "Get User",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/user/{{personId}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "user",
                                        "{{personId}}"
                                    ]
                                },
                                "description": "Returns the user record (login, type, organization) for the given person ID."
                            },
                            "response": [
                                {
                                    "name": "OK. `disabledAt` is `null` for active users, or the deactivation timestamp when the login is inactive.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user/{{personId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user",
                                                "{{personId}}"
                                            ]
                                        },
                                        "description": "Returns the user record (login, type, organization) for the given person ID."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"personId\": 44,\n    \"login\": \"maria.silva\",\n    \"disabledAt\": null\n}"
                                }
                            ]
                        },
                        {
                            "name": "Person IDs by Login Status",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/users/person-ids",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "users",
                                        "person-ids"
                                    ]
                                },
                                "description": "Returns all staff/admin person IDs grouped by login status (active, inactive, invitePending). No pagination — returns simple integer arrays. Lightweight endpoint (~3 KB for 500 people) used by the admin panel to determine login status without fetching full user records."
                            },
                            "response": [
                                {
                                    "name": "OK. Four arrays of integer person IDs grouped by login status.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/users/person-ids",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "users",
                                                "person-ids"
                                            ]
                                        },
                                        "description": "Returns all staff/admin person IDs grouped by login status (active, inactive, invitePending). No pagination — returns simple integer arrays. Lightweight endpoint (~3 KB for 500 people) used by the admin panel to determine login status without fetching full user records."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"all\": [1, 5, 12, 45, 89],\n    \"active\": [1, 5, 12, 45],\n    \"inactive\": [89],\n    \"invitePending\": [12, 45]\n}"
                                }
                            ]
                        },
                        {
                            "name": "Users Status (batch)",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/users/status",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "users",
                                        "status"
                                    ]
                                },
                                "description": "Returns the active/inactive status for a list of person IDs in a single call. Only person IDs that actually have a login (connect user) in the organization are returned. Used by the admin panel user list to render the status badge without one request per row.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"personIds\": [44, 51, 77]\r\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK. One entry per person ID that has a login; missing IDs simply have no login.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/users/status",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "users",
                                                "status"
                                            ]
                                        },
                                        "description": "Returns the active/inactive status for a list of person IDs in a single call. Only person IDs that actually have a login (connect user) in the organization are returned. Used by the admin panel user list to render the status badge without one request per row.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"personIds\": [44, 51, 77]\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "[\n    { \"personId\": 44, \"active\": true },\n    { \"personId\": 51, \"active\": false }\n]"
                                }
                            ]
                        },
                        {
                            "name": "Token",
                            "item": [
                                {
                                    "name": "Access token",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/authToken/byPerson/{{personId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "authToken",
                                                "byPerson",
                                                "{{personId}}"
                                            ]
                                        },
                                        "description": "Creates a 30-day access token for the given person ID and returns it."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/connect/authToken/byPerson/{{personId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "connect",
                                                        "authToken",
                                                        "byPerson",
                                                        "{{personId}}"
                                                    ]
                                                },
                                                "description": "Creates a 30-day access token for the given person ID and returns it."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"organization\": \"acme\",\n    \"personId\": \"123456\",\n    \"token\": \"AEFB631DE1E07B31\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Auth",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/authToken/{{token}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "authToken",
                                                "{{token}}"
                                            ]
                                        },
                                        "description": "Issues an authorization token from your API key + secret."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/connect/authToken/{{token}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "connect",
                                                        "authToken",
                                                        "{{token}}"
                                                    ]
                                                },
                                                "description": "Issues an authorization token from your API key + secret."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"personId\": 123456,\n    \"login\": \"tintim@guper.com\",\n    \"type\": \"user\"\n}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Update User",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "connect",
                                        "user"
                                    ]
                                },
                                "description": "Updates **one** user login of the organization. `personId` and `login`\nmust both be sent and must belong to the same user: the `login` locates\nthe record and the `personId` confirms it, so a wrong pair changes\nnothing and answers `404` or `409`.\n\nOnly `password`, `type` and `active` can be changed. Fields you omit stay\nas they are.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"personId\": \"44\",\r\n    \"login\": \"tintim\",\r\n    \"password\": \"a10b20c30\",\r\n    \"active\": false\r\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "User updated",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Updates **one** user login of the organization. `personId` and `login`\nmust both be sent and must belong to the same user: the `login` locates\nthe record and the `personId` confirms it, so a wrong pair changes\nnothing and answers `404` or `409`.\n\nOnly `password`, `type` and `active` can be changed. Fields you omit stay\nas they are.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"personId\": \"44\",\r\n    \"login\": \"tintim\",\r\n    \"password\": \"a10b20c30\",\r\n    \"active\": false\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"affectedRows\": 1\n}"
                                },
                                {
                                    "name": "`personId` or `login` missing — or the new password was used before",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Updates **one** user login of the organization. `personId` and `login`\nmust both be sent and must belong to the same user: the `login` locates\nthe record and the `personId` confirms it, so a wrong pair changes\nnothing and answers `404` or `409`.\n\nOnly `password`, `type` and `active` can be changed. Fields you omit stay\nas they are.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"personId\": \"44\",\r\n    \"login\": \"tintim\",\r\n    \"password\": \"a10b20c30\",\r\n    \"active\": false\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   400,\n    \"reason_phrase\": \"Bad Request\",\n    \"message\":       \"The 'personId' and 'login' parameters are required\"\n}"
                                },
                                {
                                    "name": "No user with that `login` in this organization",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Updates **one** user login of the organization. `personId` and `login`\nmust both be sent and must belong to the same user: the `login` locates\nthe record and the `personId` confirms it, so a wrong pair changes\nnothing and answers `404` or `409`.\n\nOnly `password`, `type` and `active` can be changed. Fields you omit stay\nas they are.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"personId\": \"44\",\r\n    \"login\": \"tintim\",\r\n    \"password\": \"a10b20c30\",\r\n    \"active\": false\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   404,\n    \"reason_phrase\": \"Not Found\",\n    \"message\":       \"The 'login' provided was not found\"\n}"
                                },
                                {
                                    "name": "The `login` exists but belongs to another `personId`",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/connect/user",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "connect",
                                                "user"
                                            ]
                                        },
                                        "description": "Updates **one** user login of the organization. `personId` and `login`\nmust both be sent and must belong to the same user: the `login` locates\nthe record and the `personId` confirms it, so a wrong pair changes\nnothing and answers `404` or `409`.\n\nOnly `password`, `type` and `active` can be changed. Fields you omit stay\nas they are.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"personId\": \"44\",\r\n    \"login\": \"tintim\",\r\n    \"password\": \"a10b20c30\",\r\n    \"active\": false\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\":   409,\n    \"reason_phrase\": \"Conflict\",\n    \"message\":       \"The 'login' provided belongs to another user\"\n}"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Integration",
            "item": [
                {
                    "name": "Interface",
                    "item": [
                        {
                            "name": "By field",
                            "item": [
                                {
                                    "name": "Read interface by slug",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface/by/slug/{{slug}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface",
                                                "by",
                                                "slug",
                                                "{{slug}}"
                                            ]
                                        },
                                        "description": "Returns the interface matching `(organization, slug)`. **Hot path** consumed by `loyalty.Services\\Middleware\\Interfaces\\Finding` on every `reward/search` — handle with care."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "signature",
                                                        "value": "{{signature}}",
                                                        "type": "text",
                                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                                    },
                                                    {
                                                        "key": "User-Agent",
                                                        "value": "{{User-Agent}}",
                                                        "type": "text",
                                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface/by/slug/{{slug}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "integration",
                                                        "interface",
                                                        "by",
                                                        "slug",
                                                        "{{slug}}"
                                                    ]
                                                },
                                                "description": "Returns the interface matching `(organization, slug)`. **Hot path** consumed by `loyalty.Services\\Middleware\\Interfaces\\Finding` on every `reward/search` — handle with care."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\": 41, \"organization\": \"xpto\", \"slug\": \"ecommerce\", \"name\": \"E-commerce\", \"source\": \"vtex\", \"activated\": \"2026-01-15T10:00:00+00:00\"}"
                                        },
                                        {
                                            "name": "Not Found",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "signature",
                                                        "value": "{{signature}}",
                                                        "type": "text",
                                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                                    },
                                                    {
                                                        "key": "User-Agent",
                                                        "value": "{{User-Agent}}",
                                                        "type": "text",
                                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface/by/slug/{{slug}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "integration",
                                                        "interface",
                                                        "by",
                                                        "slug",
                                                        "{{slug}}"
                                                    ]
                                                },
                                                "description": "Returns the interface matching `(organization, slug)`. **Hot path** consumed by `loyalty.Services\\Middleware\\Interfaces\\Finding` on every `reward/search` — handle with care."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"error\": \"Integration [ecommerce] not found\"}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List interfaces by source",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface/by/source/{{source}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface",
                                                "by",
                                                "source",
                                                "{{source}}"
                                            ]
                                        },
                                        "description": "Returns every interface of the given `source` activated for the org. Useful e.g. to find every VTEX tenant the org has."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "signature",
                                                        "value": "{{signature}}",
                                                        "type": "text",
                                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                                    },
                                                    {
                                                        "key": "User-Agent",
                                                        "value": "{{User-Agent}}",
                                                        "type": "text",
                                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface/by/source/{{source}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "integration",
                                                        "interface",
                                                        "by",
                                                        "source",
                                                        "{{source}}"
                                                    ]
                                                },
                                                "description": "Returns every interface of the given `source` activated for the org. Useful e.g. to find every VTEX tenant the org has."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\"id\": 41, \"organization\": \"xpto\", \"slug\": \"ecommerce\", \"name\": \"E-commerce\", \"source\": \"vtex\", \"activated\": \"2026-01-15T10:00:00+00:00\"}\n]"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Create interface",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "interface"
                                    ]
                                },
                                "description": "Activates a new integration for the org. `slug` must be unique inside `(organization, slug)`. `activated` accepts a boolean: `true` sets the current timestamp, `false` (or omitted) leaves it `null` (= integration registered but not yet enabled).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"ecommerce\",\n    \"name\": \"E-commerce\",\n    \"source\": \"vtex\",\n    \"activated\": \"true\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface"
                                            ]
                                        },
                                        "description": "Activates a new integration for the org. `slug` must be unique inside `(organization, slug)`. `activated` accepts a boolean: `true` sets the current timestamp, `false` (or omitted) leaves it `null` (= integration registered but not yet enabled).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"ecommerce\",\n    \"name\": \"E-commerce\",\n    \"source\": \"vtex\",\n    \"activated\": \"true\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Created",
                                    "code": 201,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"id\": 102, \"organization\": \"xpto\", \"slug\": \"ecommerce\", \"name\": \"E-commerce\", \"source\": \"vtex\", \"activated\": \"2026-06-24T12:00:00+00:00\"}"
                                },
                                {
                                    "name": "Conflict (duplicate)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface"
                                            ]
                                        },
                                        "description": "Activates a new integration for the org. `slug` must be unique inside `(organization, slug)`. `activated` accepts a boolean: `true` sets the current timestamp, `false` (or omitted) leaves it `null` (= integration registered but not yet enabled).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"ecommerce\",\n    \"name\": \"E-commerce\",\n    \"source\": \"vtex\",\n    \"activated\": \"true\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"error\": \"Duplicate entry for (organization, slug)\"}"
                                }
                            ]
                        },
                        {
                            "name": "Delete interface",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "interface",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Removes a interface. Irreversible — does not soft-delete. Make sure no cron/job is still keyed off this id."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Removes a interface. Irreversible — does not soft-delete. Make sure no cron/job is still keyed off this id."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"deleted\": true}"
                                }
                            ]
                        },
                        {
                            "name": "List interfaces",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "interface"
                                    ]
                                },
                                "description": "Lists every integration activated for the org (derived from the signature header). Supports the standard `Tools\\Data\\Listing` query params (`p`/`page`, `e`/`entries`, `q[col][OP]`)."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface"
                                            ]
                                        },
                                        "description": "Lists every integration activated for the org (derived from the signature header). Supports the standard `Tools\\Data\\Listing` query params (`p`/`page`, `e`/`entries`, `q[col][OP]`)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\"id\": 41, \"organization\": \"xpto\", \"slug\": \"ecommerce\", \"name\": \"E-commerce\", \"source\": \"vtex\", \"activated\": \"2026-01-15T10:00:00+00:00\"},\n        {\"id\": 42, \"organization\": \"xpto\", \"slug\": \"loja-fisica\", \"name\": \"Loja Física\", \"source\": \"linx\", \"activated\": null}\n    ],\n    \"total\": 2,\n    \"pagination\": {\"entries\": 50, \"currentPage\": 1, \"totalPages\": 1}\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get interface",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "interface",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single interface by id. Implicit org filter — returns 404 if the id belongs to another org."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single interface by id. Implicit org filter — returns 404 if the id belongs to another org."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"id\": 41, \"organization\": \"xpto\", \"slug\": \"ecommerce\", \"name\": \"E-commerce\", \"source\": \"vtex\", \"activated\": \"2026-01-15T10:00:00+00:00\"}"
                                },
                                {
                                    "name": "Not Found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single interface by id. Implicit org filter — returns 404 if the id belongs to another org."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"error\": \"Not Found\"}"
                                }
                            ]
                        },
                        {
                            "name": "Update interface",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "interface",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Updates fields of an existing interface. Pass `activated: true` to enable, `activated: false` to disable.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"ecommerce\",\n    \"name\": \"E-commerce Brasil\",\n    \"source\": \"vtex\",\n    \"activated\": \"true\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/interface/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "interface",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates fields of an existing interface. Pass `activated: true` to enable, `activated: false` to disable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"ecommerce\",\n    \"name\": \"E-commerce Brasil\",\n    \"source\": \"vtex\",\n    \"activated\": \"true\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"id\": 102, \"organization\": \"xpto\", \"slug\": \"ecommerce\", \"name\": \"E-commerce Brasil\", \"source\": \"vtex\", \"activated\": \"2026-06-24T12:00:00+00:00\"}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": "RSA signature `account.service.token` validated against the org public key."
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/integration/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "integration",
                                "ping"
                            ]
                        },
                        "description": "Health check endpoint. No auth required."
                    },
                    "response": [
                        {
                            "name": "OK",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "ping"
                                    ]
                                },
                                "description": "Health check endpoint. No auth required."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\"pong\":true}"
                        }
                    ]
                },
                {
                    "name": "Source",
                    "item": [
                        {
                            "name": "Create source",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/source",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "source"
                                    ]
                                },
                                "description": "Registers a new integration type globally. `slug` must be unique. Use sparingly — done once per new platform Guper supports.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"cegid\",\n    \"name\": \"Cegid\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source"
                                            ]
                                        },
                                        "description": "Registers a new integration type globally. `slug` must be unique. Use sparingly — done once per new platform Guper supports.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"cegid\",\n    \"name\": \"Cegid\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Created",
                                    "code": 201,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"id\": 11, \"slug\": \"cegid\", \"name\": \"Cegid\"}"
                                },
                                {
                                    "name": "Conflict (duplicate)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source"
                                            ]
                                        },
                                        "description": "Registers a new integration type globally. `slug` must be unique. Use sparingly — done once per new platform Guper supports.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"cegid\",\n    \"name\": \"Cegid\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"error\": \"Duplicate entry for slug\"}"
                                }
                            ]
                        },
                        {
                            "name": "Delete source",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "source",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Removes a source. Caller is responsible for ensuring no `tenant` rows still reference it — referential integrity is not enforced at the DB level (logical FK)."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Removes a source. Caller is responsible for ensuring no `tenant` rows still reference it — referential integrity is not enforced at the DB level (logical FK)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"deleted\": true}"
                                }
                            ]
                        },
                        {
                            "name": "List sources",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/source",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "source"
                                    ]
                                },
                                "description": "Returns the global master list of integration types. **Not org-scoped** — every org sees the same list. Use as the FK target for `tenant.source`."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source"
                                            ]
                                        },
                                        "description": "Returns the global master list of integration types. **Not org-scoped** — every org sees the same list. Use as the FK target for `tenant.source`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\"id\": 2, \"slug\": \"vtex\", \"name\": \"Vtex\"},\n        {\"id\": 3, \"slug\": \"shopify\", \"name\": \"Shopify\"},\n        {\"id\": 4, \"slug\": \"linx\", \"name\": \"Linx\"}\n    ],\n    \"total\": 10,\n    \"pagination\": {\"entries\": 50, \"currentPage\": 1, \"totalPages\": 1}\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get source",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "source",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single source by id."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single source by id."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"id\": 2, \"slug\": \"vtex\", \"name\": \"Vtex\"}"
                                },
                                {
                                    "name": "Not Found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single source by id."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"error\": \"Not Found\"}"
                                }
                            ]
                        },
                        {
                            "name": "Update source",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": "RSA signature `account.service.token` validated against the org public key."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "integration",
                                        "source",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Updates fields of an existing source. `slug` updates propagate to every `tenant.source` referencing it.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"cegid\",\n    \"name\": \"Cegid\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "signature",
                                                "value": "{{signature}}",
                                                "type": "text",
                                                "description": "RSA signature `account.service.token` validated against the org public key."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Caller service name (e.g. `middleware`, `loyalty`)."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/integration/source/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "integration",
                                                "source",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates fields of an existing source. `slug` updates propagate to every `tenant.source` referencing it.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"cegid\",\n    \"name\": \"Cegid\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"id\": 11, \"slug\": \"cegid\", \"name\": \"Cegid\"}"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Loyalty",
            "item": [
                {
                    "name": "Campaigns",
                    "item": [
                        {
                            "name": "Campaign rules",
                            "item": [
                                {
                                    "name": "Create",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign",
                                                "rule"
                                            ]
                                        },
                                        "description": "Adds a rule to a campaign. A rule NARROWS what the campaign matches — the order, the\nitems or the audience — so the campaign only rewards when every rule passes.\n\nA rule is a `code` (which rule) plus `params` (the values it checks). **The three things\nthat trip people up:**\n\n1. **Each `code` expects a DIFFERENT `params` format** — cents for amounts, arrays of IDs\n   for categories/brands, an object for tier level. Using the wrong shape silently makes\n   the rule never match. The per-code format is listed under `params` below.\n2. **Monetary params are in CENTS.** `[\"250001\"]` on code 1 means R$ 2.500,01 — not 250k.\n3. **The rule's SCOPE must match the campaign's `trigger`.** Codes 1–16 are `campaign`\n   scope (normal campaigns). Codes 17–18 are `member-event` scope and only work on a\n   campaign whose `trigger` is `member-event`. Mixing them makes the rule dead weight.\n\nThe authoritative list comes from `GET /api/loyalty/rule`; the table below is a snapshot.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"campaign\": 1,\n    \"code\": 1,\n    \"params\": [\n        \"250001\"\n    ],\n    \"reverse\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Success — returns the created rule (id assigned by the database).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "campaign",
                                                        "rule"
                                                    ]
                                                },
                                                "description": "Adds a rule to a campaign. A rule NARROWS what the campaign matches — the order, the\nitems or the audience — so the campaign only rewards when every rule passes.\n\nA rule is a `code` (which rule) plus `params` (the values it checks). **The three things\nthat trip people up:**\n\n1. **Each `code` expects a DIFFERENT `params` format** — cents for amounts, arrays of IDs\n   for categories/brands, an object for tier level. Using the wrong shape silently makes\n   the rule never match. The per-code format is listed under `params` below.\n2. **Monetary params are in CENTS.** `[\"250001\"]` on code 1 means R$ 2.500,01 — not 250k.\n3. **The rule's SCOPE must match the campaign's `trigger`.** Codes 1–16 are `campaign`\n   scope (normal campaigns). Codes 17–18 are `member-event` scope and only work on a\n   campaign whose `trigger` is `member-event`. Mixing them makes the rule dead weight.\n\nThe authoritative list comes from `GET /api/loyalty/rule`; the table below is a snapshot.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"campaign\": 1,\n    \"code\": 1,\n    \"params\": [\n        \"250001\"\n    ],\n    \"reverse\": false\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign",
                                                "rule"
                                            ]
                                        },
                                        "description": "Removes a campaign rule by ID.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Success.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "campaign",
                                                        "rule"
                                                    ]
                                                },
                                                "description": "Removes a campaign rule by ID.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "`id` missing in body.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "campaign",
                                                        "rule"
                                                    ]
                                                },
                                                "description": "Removes a campaign rule by ID.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign",
                                                "rule"
                                            ]
                                        },
                                        "description": "Returns the paginated list of campaign rules."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "campaign",
                                                        "rule"
                                                    ]
                                                },
                                                "description": "Returns the paginated list of campaign rules."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        {\n            \"id\": 1,\n            \"name\": \"My Wallet\"\n        }\n    ],\n    \"total\": 1,\n    \"pagination\": {\n        \"entries\": 20,\n        \"totalPages\": 1,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": true,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 0\n    }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign",
                                                "rule"
                                            ]
                                        },
                                        "description": "Updates an existing campaign rule. Only `id` is strictly required — every other field\naccepted by [Create rule](../create) can also appear here and is partially merged into\nthe record.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"campaign\": 0,\n    \"code\": 2,\n    \"params\": [\n        \"45\"\n    ],\n    \"reverse\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Success — returns the updated record.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/rule",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "campaign",
                                                        "rule"
                                                    ]
                                                },
                                                "description": "Updates an existing campaign rule. Only `id` is strictly required — every other field\naccepted by [Create rule](../create) can also appear here and is partially merged into\nthe record.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"campaign\": 0,\n    \"code\": 2,\n    \"params\": [\n        \"45\"\n    ],\n    \"reverse\": false\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Create",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "campaign"
                                    ]
                                },
                                "description": "Creates a new loyalty campaign — how cashback (or points) is generated for orders: the\nrate (`aliquot`/`aliquotType`), the trigger, the validity window and the reward type.\n\n**This is a financial, hard-to-reverse write. Get the enum values EXACTLY right.** This\ndatabase has no STRICT mode: an invalid ENUM value is stored as an empty string **in\nsilence** (no error), and the campaign then behaves in ways nobody asked for. Every field\nbelow whose type says `enum(...)` lists its only accepted values — do not invent others\n(`client`, `points`, `delay` are NOT valid).\n\n**Required for a successful insert** (NOT NULL in the schema — the controller only checks\n`name`, but the database rejects the row without these): `name`, `aliquot`, `initAt`,\n`finishAt`, `storeGroups`, `segmentations`. Sending only `name` returns a 500.\n\nA campaign created with `trigger: audience-list` is automatically paired with a\n`CampaignAudience` record that drives audience-based scheduling.\n\n**HOW TO CREATE ONE — guided flow. Do NOT dump the whole form, and do NOT guess.**\nWalk the user through it one group at a time. For anything they already told you, restate\nyour understanding and ask them to confirm — do not ask again. Ask only for what is still\nmissing, in this order:\n\n  1. **Basics** — `name`; what fires it (`trigger`); and the reward: `rewardType`\n     (`monetary`/`point`) with the rate (`aliquot` + `aliquotType`; amounts in cents).\n  2. **Window** — `initAt` and `finishAt` (when the campaign evaluates orders).\n  3. **Redeemability** — `availabilityMode`: `consecutiveDays` (`delayTime`/`expiryTime`,\n     in SECONDS) or `dateRange` (`dateRangeStart`/`dateRangeEnd`).\n  4. **Reach** — `storeGroups` (empty = all stores) and any `segmentations`.\n  5. **Narrowing rules (optional)** — ask whether to limit by minimum/maximum value,\n     category, brand, tier, etc. Each is a SEPARATE call to the campaign-rule endpoint\n     after the campaign exists; see its docs for the per-rule `params` format.\n\nThen show a FULL preview — every field, in plain language, amounts formatted back from\ncents — and execute ONLY after the user explicitly confirms. This operation is financial\nand requires `confirmar=true`, so it will not run without that confirmation regardless.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Aniversário — 10% cashback\",\n    \"displayName\": \"Feliz aniversário!\",\n    \"beneficiaryType\": \"buyer\",\n    \"trigger\": \"purchase\",\n    \"eventType\": \"tier_achieved\",\n    \"type\": \"monetary\",\n    \"isActive\": true,\n    \"isDraft\": false,\n    \"rewardType\": \"monetary\",\n    \"pointsDividend\": 1,\n    \"pointsDivisor\": 1,\n    \"aliquot\": 1000,\n    \"aliquotType\": 0,\n    \"coupon\": 0,\n    \"recurrentByOrder\": false,\n    \"availabilityMode\": \"consecutiveDays\",\n    \"delayTime\": 86400,\n    \"expiryTime\": 1296000,\n    \"expiryPeriod\": \"<expiryPeriod>\",\n    \"dateRangeStart\": \"2026-03-01T00:00:00-03:00\",\n    \"dateRangeEnd\": \"2026-12-31T23:59:59-03:00\",\n    \"initAt\": \"2026-03-01T00:00:00-03:00\",\n    \"finishAt\": \"2026-03-31T23:59:59-03:00\",\n    \"storeGroups\": \"\",\n    \"segmentations\": \"[]\",\n    \"redemptionPolicy\": 0,\n    \"messageSequence\": \"<messageSequence>\",\n    \"campaignTag\": 0,\n    \"rewardSegmentAdd\": \"<rewardSegmentAdd>\",\n    \"rewardSegmentDel\": \"<rewardSegmentDel>\",\n    \"list\": 0,\n    \"reactivateWithActiveCards\": false,\n    \"skipWithActiveCards\": true,\n    \"reactivationDateStart\": \"<reactivationDateStart>\",\n    \"reactivationDateEnd\": \"<reactivationDateEnd>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success — returns the persisted record (id assigned by the database).",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign"
                                            ]
                                        },
                                        "description": "Creates a new loyalty campaign — how cashback (or points) is generated for orders: the\nrate (`aliquot`/`aliquotType`), the trigger, the validity window and the reward type.\n\n**This is a financial, hard-to-reverse write. Get the enum values EXACTLY right.** This\ndatabase has no STRICT mode: an invalid ENUM value is stored as an empty string **in\nsilence** (no error), and the campaign then behaves in ways nobody asked for. Every field\nbelow whose type says `enum(...)` lists its only accepted values — do not invent others\n(`client`, `points`, `delay` are NOT valid).\n\n**Required for a successful insert** (NOT NULL in the schema — the controller only checks\n`name`, but the database rejects the row without these): `name`, `aliquot`, `initAt`,\n`finishAt`, `storeGroups`, `segmentations`. Sending only `name` returns a 500.\n\nA campaign created with `trigger: audience-list` is automatically paired with a\n`CampaignAudience` record that drives audience-based scheduling.\n\n**HOW TO CREATE ONE — guided flow. Do NOT dump the whole form, and do NOT guess.**\nWalk the user through it one group at a time. For anything they already told you, restate\nyour understanding and ask them to confirm — do not ask again. Ask only for what is still\nmissing, in this order:\n\n  1. **Basics** — `name`; what fires it (`trigger`); and the reward: `rewardType`\n     (`monetary`/`point`) with the rate (`aliquot` + `aliquotType`; amounts in cents).\n  2. **Window** — `initAt` and `finishAt` (when the campaign evaluates orders).\n  3. **Redeemability** — `availabilityMode`: `consecutiveDays` (`delayTime`/`expiryTime`,\n     in SECONDS) or `dateRange` (`dateRangeStart`/`dateRangeEnd`).\n  4. **Reach** — `storeGroups` (empty = all stores) and any `segmentations`.\n  5. **Narrowing rules (optional)** — ask whether to limit by minimum/maximum value,\n     category, brand, tier, etc. Each is a SEPARATE call to the campaign-rule endpoint\n     after the campaign exists; see its docs for the per-rule `params` format.\n\nThen show a FULL preview — every field, in plain language, amounts formatted back from\ncents — and execute ONLY after the user explicitly confirms. This operation is financial\nand requires `confirmar=true`, so it will not run without that confirmation regardless.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Aniversário — 10% cashback\",\n    \"displayName\": \"Feliz aniversário!\",\n    \"beneficiaryType\": \"buyer\",\n    \"trigger\": \"purchase\",\n    \"eventType\": \"tier_achieved\",\n    \"type\": \"monetary\",\n    \"isActive\": true,\n    \"isDraft\": false,\n    \"rewardType\": \"monetary\",\n    \"pointsDividend\": 1,\n    \"pointsDivisor\": 1,\n    \"aliquot\": 1000,\n    \"aliquotType\": 0,\n    \"coupon\": 0,\n    \"recurrentByOrder\": false,\n    \"availabilityMode\": \"consecutiveDays\",\n    \"delayTime\": 86400,\n    \"expiryTime\": 1296000,\n    \"expiryPeriod\": \"<expiryPeriod>\",\n    \"dateRangeStart\": \"2026-03-01T00:00:00-03:00\",\n    \"dateRangeEnd\": \"2026-12-31T23:59:59-03:00\",\n    \"initAt\": \"2026-03-01T00:00:00-03:00\",\n    \"finishAt\": \"2026-03-31T23:59:59-03:00\",\n    \"storeGroups\": \"\",\n    \"segmentations\": \"[]\",\n    \"redemptionPolicy\": 0,\n    \"messageSequence\": \"<messageSequence>\",\n    \"campaignTag\": 0,\n    \"rewardSegmentAdd\": \"<rewardSegmentAdd>\",\n    \"rewardSegmentDel\": \"<rewardSegmentDel>\",\n    \"list\": 0,\n    \"reactivateWithActiveCards\": false,\n    \"skipWithActiveCards\": true,\n    \"reactivationDateStart\": \"<reactivationDateStart>\",\n    \"reactivationDateEnd\": \"<reactivationDateEnd>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Delete",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "campaign"
                                    ]
                                },
                                "description": "Removes a campaign by ID. Cards already issued by the campaign are kept — only the campaign\ndefinition is deleted. Existing rules attached to the campaign (`campaign_rule`) are\ncascaded by the database.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 1\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign"
                                            ]
                                        },
                                        "description": "Removes a campaign by ID. Cards already issued by the campaign are kept — only the campaign\ndefinition is deleted. Existing rules attached to the campaign (`campaign_rule`) are\ncascaded by the database.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "`id` missing in body.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign"
                                            ]
                                        },
                                        "description": "Removes a campaign by ID. Cards already issued by the campaign are kept — only the campaign\ndefinition is deleted. Existing rules attached to the campaign (`campaign_rule`) are\ncascaded by the database.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "List Campaigns",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "campaign"
                                    ]
                                },
                                "description": "Paginated list of loyalty/cashback campaigns. Filter by name, trigger or type\nthrough the shared listing grammar. Returns the campaign setup, not its\nresults — for cards generated, value distributed and redeemed, see the\ncampaign report.\n\nEvery row carries a derived `status`: `active`, `draft`, `paused` or `finished`.\n`draft` is a campaign saved but not published yet (`isDraft`): it never runs\nand wins over every other status.\n`finished` is not a column: for `audience-list` campaigns it means the send\nis over (`audience-status` = `finished`); for every other trigger it means the\ncampaign period (`finishAt`) has ended. `finished` wins over `isActive` — a\ncampaign whose period ended but is still switched on comes back as\n`finished`. The status is read-only: it never changes `isActive`."
                            },
                            "response": [
                                {
                                    "name": "Success. Each item in `list` has `status`; `statusCounts` only when requested.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign"
                                            ]
                                        },
                                        "description": "Paginated list of loyalty/cashback campaigns. Filter by name, trigger or type\nthrough the shared listing grammar. Returns the campaign setup, not its\nresults — for cards generated, value distributed and redeemed, see the\ncampaign report.\n\nEvery row carries a derived `status`: `active`, `draft`, `paused` or `finished`.\n`draft` is a campaign saved but not published yet (`isDraft`): it never runs\nand wins over every other status.\n`finished` is not a column: for `audience-list` campaigns it means the send\nis over (`audience-status` = `finished`); for every other trigger it means the\ncampaign period (`finishAt`) has ended. `finished` wins over `isActive` — a\ncampaign whose period ended but is still switched on comes back as\n`finished`. The status is read-only: it never changes `isActive`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "List Campaign and Rules",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaigns",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "campaigns"
                                    ]
                                },
                                "description": "Returns the paginated list of campaigns including their rules."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaigns",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaigns"
                                            ]
                                        },
                                        "description": "Returns the paginated list of campaigns including their rules."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Get Campaign",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "campaign",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single the campaign matching the given identifier."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single the campaign matching the given identifier."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 1,\n    \"name\": \"My Campaign\",\n    \"aliquot\": 5,\n    \"aliquotType\": 1,\n    \"recurrentByOrder\": 0,\n    \"expiryTime\": 5184000,\n    \"initAt\": {\n        \"date\": \"2023-07-01 06:00:00.000000\",\n        \"timezone_type\": 3,\n        \"timezone\": \"America/Sao_Paulo\"\n    },\n    \"finishAt\": {\n        \"date\": \"2023-12-31 18:00:00.000000\",\n        \"timezone_type\": 3,\n        \"timezone\": \"America/Sao_Paulo\"\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Update",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "campaign"
                                    ]
                                },
                                "description": "Updates an existing campaign. Only `id` is strictly required — every other field present\nin [Create campaign](../create) can also appear here and is partially merged into the\nrecord (only the keys you send are updated).\n\nWhen the campaign trigger is `audience-list`, the paired `CampaignAudience` record is\nre-synchronized: toggling `isActive` flips its status between `running` and `standby`.\n\nFor `member-event` campaigns, `eventType` is the field that decides which lifecycle\nevent fires the campaign (`membership_joined` or `tier_achieved`). To filter by\na specific tier level on `tier_achieved`, attach a `campaign_rule` with code `17`\n(see [Campaign rules](../campaign-rules/create)).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 1,\n    \"name\": \"My Campaign\",\n    \"displayName\": \"<displayName>\",\n    \"isActive\": false,\n    \"isDraft\": false,\n    \"aliquot\": 0,\n    \"aliquotType\": 0,\n    \"dateRangeStart\": \"<dateRangeStart>\",\n    \"dateRangeEnd\": \"<dateRangeEnd>\",\n    \"initAt\": \"<initAt>\",\n    \"finishAt\": \"<finishAt>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success — returns the updated record.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/campaign",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "campaign"
                                            ]
                                        },
                                        "description": "Updates an existing campaign. Only `id` is strictly required — every other field present\nin [Create campaign](../create) can also appear here and is partially merged into the\nrecord (only the keys you send are updated).\n\nWhen the campaign trigger is `audience-list`, the paired `CampaignAudience` record is\nre-synchronized: toggling `isActive` flips its status between `running` and `standby`.\n\nFor `member-event` campaigns, `eventType` is the field that decides which lifecycle\nevent fires the campaign (`membership_joined` or `tier_achieved`). To filter by\na specific tier level on `tier_achieved`, attach a `campaign_rule` with code `17`\n(see [Campaign rules](../campaign-rules/create)).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"name\": \"My Campaign\",\n    \"displayName\": \"<displayName>\",\n    \"isActive\": false,\n    \"isDraft\": false,\n    \"aliquot\": 0,\n    \"aliquotType\": 0,\n    \"dateRangeStart\": \"<dateRangeStart>\",\n    \"dateRangeEnd\": \"<dateRangeEnd>\",\n    \"initAt\": \"<initAt>\",\n    \"finishAt\": \"<finishAt>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Cards",
                    "item": [
                        {
                            "name": "Card: By Order",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/card/byOrder",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "card",
                                        "byOrder"
                                    ]
                                },
                                "description": "Generates reward cards directly from an order payload — admin / manual\nissuance bypassing the standard reward flow. Same shape as\n[Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nplus an optional `amountToRedeem` override.\n\nBypasses the checkout flow entirely: no reservation and no confirm step.\n\nThis is the same route documented at\n[Reward · Create by Order](/docs/{lang}/api-reference/loyalty/reward/create-by-order)\n— kept here under `card/` as well because legacy integrations reference\nthat path.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": {\n        \"id\": 47,\n        \"refId\": \"3143c4fb\",\n        \"name\": \"Trifólio Girassol\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"trifolio@girassol.com\",\n        \"document\": \"<document>\"\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000,\n            \"categoryId\": \"<categoryId>\",\n            \"brandId\": \"<brandId>\",\n            \"tax\": 0\n        }\n    ],\n    \"total_order\": 97390,\n    \"total_item\": 96390,\n    \"total_shipping\": 2000,\n    \"total_discounts\": 1000,\n    \"amountToRedeem\": 0\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Cards generated",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/card/byOrder",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "card",
                                                "byOrder"
                                            ]
                                        },
                                        "description": "Generates reward cards directly from an order payload — admin / manual\nissuance bypassing the standard reward flow. Same shape as\n[Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nplus an optional `amountToRedeem` override.\n\nBypasses the checkout flow entirely: no reservation and no confirm step.\n\nThis is the same route documented at\n[Reward · Create by Order](/docs/{lang}/api-reference/loyalty/reward/create-by-order)\n— kept here under `card/` as well because legacy integrations reference\nthat path.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": {\n        \"id\": 47,\n        \"refId\": \"3143c4fb\",\n        \"name\": \"Trifólio Girassol\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"trifolio@girassol.com\",\n        \"document\": \"<document>\"\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000,\n            \"categoryId\": \"<categoryId>\",\n            \"brandId\": \"<brandId>\",\n            \"tax\": 0\n        }\n    ],\n    \"total_order\": 97390,\n    \"total_item\": 96390,\n    \"total_shipping\": 2000,\n    \"total_discounts\": 1000,\n    \"amountToRedeem\": 0\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Cancel Card",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/cancel",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cards",
                                        "{{id}}",
                                        "cancel"
                                    ]
                                },
                                "description": "Cancels a single card. The card leaves circulation immediately: it stops counting as\nbalance, stops being redeemable and reads as `canceled` everywhere.\n\nA card carries no status column - `canceled` is derived from the cancellation timestamp,\nso this endpoint **is** what \"set the card status to canceled\" means.\n\nCanceling a card is a change of **state**, not a movement of money: the balance is neither\ndebited nor returned, and no line is written to the card flow ledger. The card simply drops\nout of every balance query. Pick the operation by intent:\n\n- the whole card should stop existing for the customer - **this endpoint**;\n- value should leave a card that stays alive - [Adjust Card Balance](/docs/{lang}/api-reference/loyalty/card/adjust) (`manual_debit`, recorded in the ledger);\n- a purchase was reverted and its cashback must go with it - cancel the transaction, not the card.\n\nReversible through [Reactivate Card](/docs/{lang}/api-reference/loyalty/card/reactivate).\n\nA card holding an **open redemption reservation** is refused with `409`: the reserved value\nwas already debited and is waiting to be settled or returned, so canceling the card would\nstrand it. Settle or cancel that redemption first."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/cancel",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "{{id}}",
                                                "cancel"
                                            ]
                                        },
                                        "description": "Cancels a single card. The card leaves circulation immediately: it stops counting as\nbalance, stops being redeemable and reads as `canceled` everywhere.\n\nA card carries no status column - `canceled` is derived from the cancellation timestamp,\nso this endpoint **is** what \"set the card status to canceled\" means.\n\nCanceling a card is a change of **state**, not a movement of money: the balance is neither\ndebited nor returned, and no line is written to the card flow ledger. The card simply drops\nout of every balance query. Pick the operation by intent:\n\n- the whole card should stop existing for the customer - **this endpoint**;\n- value should leave a card that stays alive - [Adjust Card Balance](/docs/{lang}/api-reference/loyalty/card/adjust) (`manual_debit`, recorded in the ledger);\n- a purchase was reverted and its cashback must go with it - cancel the transaction, not the card.\n\nReversible through [Reactivate Card](/docs/{lang}/api-reference/loyalty/card/reactivate).\n\nA card holding an **open redemption reservation** is refused with `409`: the reserved value\nwas already debited and is waiting to be settled or returned, so canceling the card would\nstrand it. Settle or cancel that redemption first."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"cardId\": 95980,\n    \"canceledAt\": \"2026-11-09T14:32:05-03:00\",\n    \"cardStatus\": \"canceled\",\n    \"amount\": 1250\n}"
                                },
                                {
                                    "name": "No card with this id in the organization.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/cancel",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "{{id}}",
                                                "cancel"
                                            ]
                                        },
                                        "description": "Cancels a single card. The card leaves circulation immediately: it stops counting as\nbalance, stops being redeemable and reads as `canceled` everywhere.\n\nA card carries no status column - `canceled` is derived from the cancellation timestamp,\nso this endpoint **is** what \"set the card status to canceled\" means.\n\nCanceling a card is a change of **state**, not a movement of money: the balance is neither\ndebited nor returned, and no line is written to the card flow ledger. The card simply drops\nout of every balance query. Pick the operation by intent:\n\n- the whole card should stop existing for the customer - **this endpoint**;\n- value should leave a card that stays alive - [Adjust Card Balance](/docs/{lang}/api-reference/loyalty/card/adjust) (`manual_debit`, recorded in the ledger);\n- a purchase was reverted and its cashback must go with it - cancel the transaction, not the card.\n\nReversible through [Reactivate Card](/docs/{lang}/api-reference/loyalty/card/reactivate).\n\nA card holding an **open redemption reservation** is refused with `409`: the reserved value\nwas already debited and is waiting to be settled or returned, so canceling the card would\nstrand it. Settle or cancel that redemption first."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Card was canceled previously, or it holds an open redemption reservation - the response carries `reservedTotal` in cents.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/cancel",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "{{id}}",
                                                "cancel"
                                            ]
                                        },
                                        "description": "Cancels a single card. The card leaves circulation immediately: it stops counting as\nbalance, stops being redeemable and reads as `canceled` everywhere.\n\nA card carries no status column - `canceled` is derived from the cancellation timestamp,\nso this endpoint **is** what \"set the card status to canceled\" means.\n\nCanceling a card is a change of **state**, not a movement of money: the balance is neither\ndebited nor returned, and no line is written to the card flow ledger. The card simply drops\nout of every balance query. Pick the operation by intent:\n\n- the whole card should stop existing for the customer - **this endpoint**;\n- value should leave a card that stays alive - [Adjust Card Balance](/docs/{lang}/api-reference/loyalty/card/adjust) (`manual_debit`, recorded in the ledger);\n- a purchase was reverted and its cashback must go with it - cancel the transaction, not the card.\n\nReversible through [Reactivate Card](/docs/{lang}/api-reference/loyalty/card/reactivate).\n\nA card holding an **open redemption reservation** is refused with `409`: the reserved value\nwas already debited and is waiting to be settled or returned, so canceling the card would\nstrand it. Settle or cancel that redemption first."
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Cancel Cards in Batch",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/cancel",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cards",
                                        "cancel"
                                    ]
                                },
                                "description": "Cancels up to 100 cards in one call. Same rules as\n[Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel) - a card leaves circulation,\nstops counting as balance and reads as `canceled`, with no money moved and no line written\nto the card flow ledger.\n\n**Partial failure is normal, not an error.** In a batch of 100 it is expected that a few\ncards are already canceled, one does not exist and another holds an open redemption\nreservation. The call answers `200` with the outcome of **each** item; `400` is reserved\nfor a malformed request (no `ids`, above the limit, or a non-numeric id).\n\nPossible outcomes per item:\n\n| `outcome` | Meaning |\n|---|---|\n| `canceled` | The card was canceled by this call |\n| `already_canceled` | It was already canceled - nothing was done, `canceledAt` is returned |\n| `has_open_reservation` | Refused: reserved value is waiting to be settled or returned (`reservedTotal`, in cents) |\n| `not_found` | No card with this id in the organization |\n\n**Run it with `dryRun` first.** It returns exactly what would happen per item plus\n`amountRemoved` - how much balance would leave circulation - and writes nothing.\n\nIds repeated in the same call are processed once. **A range never crosses organizations**: an\nid that belongs to another account comes back `not_found` and is left untouched - every query\nhere is scoped by organization, and `not_found` is also the right answer so the call cannot\nbe used to probe whether a card exists somewhere else.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"ids\": \"1512200:1512299;1512305;1512310\",\n    \"dryRun\": false\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Processed - read `results` for the outcome of each id.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/cancel",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "cancel"
                                            ]
                                        },
                                        "description": "Cancels up to 100 cards in one call. Same rules as\n[Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel) - a card leaves circulation,\nstops counting as balance and reads as `canceled`, with no money moved and no line written\nto the card flow ledger.\n\n**Partial failure is normal, not an error.** In a batch of 100 it is expected that a few\ncards are already canceled, one does not exist and another holds an open redemption\nreservation. The call answers `200` with the outcome of **each** item; `400` is reserved\nfor a malformed request (no `ids`, above the limit, or a non-numeric id).\n\nPossible outcomes per item:\n\n| `outcome` | Meaning |\n|---|---|\n| `canceled` | The card was canceled by this call |\n| `already_canceled` | It was already canceled - nothing was done, `canceledAt` is returned |\n| `has_open_reservation` | Refused: reserved value is waiting to be settled or returned (`reservedTotal`, in cents) |\n| `not_found` | No card with this id in the organization |\n\n**Run it with `dryRun` first.** It returns exactly what would happen per item plus\n`amountRemoved` - how much balance would leave circulation - and writes nothing.\n\nIds repeated in the same call are processed once. **A range never crosses organizations**: an\nid that belongs to another account comes back `not_found` and is left untouched - every query\nhere is scoped by organization, and `not_found` is also the right answer so the call cannot\nbe used to probe whether a card exists somewhere else.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"ids\": \"1512200:1512299;1512305;1512310\",\n    \"dryRun\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"batchId\": \"cb_6f2e91a4c3d1\",\n    \"dryRun\": false,\n    \"summary\": {\n        \"requested\": 4,\n        \"canceled\": 1,\n        \"reactivated\": 0,\n        \"already_canceled\": 1,\n        \"not_canceled\": 0,\n        \"has_open_reservation\": 1,\n        \"not_found\": 1,\n        \"amountRemoved\": 31200\n    },\n    \"results\": [\n        { \"id\": 1512200, \"outcome\": \"canceled\", \"amount\": 31200 },\n        { \"id\": 1512201, \"outcome\": \"already_canceled\", \"canceledAt\": \"2026-11-09T18:02:11-03:00\" },\n        { \"id\": 1512207, \"outcome\": \"has_open_reservation\", \"reservedTotal\": 5000 },\n        { \"id\": 9999999, \"outcome\": \"not_found\" }\n    ]\n}"
                                },
                                {
                                    "name": "Malformed request: `ids` missing or empty, more than 100 ids, or a non-numeric id.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/cancel",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "cancel"
                                            ]
                                        },
                                        "description": "Cancels up to 100 cards in one call. Same rules as\n[Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel) - a card leaves circulation,\nstops counting as balance and reads as `canceled`, with no money moved and no line written\nto the card flow ledger.\n\n**Partial failure is normal, not an error.** In a batch of 100 it is expected that a few\ncards are already canceled, one does not exist and another holds an open redemption\nreservation. The call answers `200` with the outcome of **each** item; `400` is reserved\nfor a malformed request (no `ids`, above the limit, or a non-numeric id).\n\nPossible outcomes per item:\n\n| `outcome` | Meaning |\n|---|---|\n| `canceled` | The card was canceled by this call |\n| `already_canceled` | It was already canceled - nothing was done, `canceledAt` is returned |\n| `has_open_reservation` | Refused: reserved value is waiting to be settled or returned (`reservedTotal`, in cents) |\n| `not_found` | No card with this id in the organization |\n\n**Run it with `dryRun` first.** It returns exactly what would happen per item plus\n`amountRemoved` - how much balance would leave circulation - and writes nothing.\n\nIds repeated in the same call are processed once. **A range never crosses organizations**: an\nid that belongs to another account comes back `not_found` and is left untouched - every query\nhere is scoped by organization, and `not_found` is also the right answer so the call cannot\nbe used to probe whether a card exists somewhere else.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"ids\": \"1512200:1512299;1512305;1512310\",\n    \"dryRun\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Card Full Data",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/full",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cards",
                                        "full"
                                    ]
                                },
                                "description": "Returns the paginated list of cashback cards with their full data."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/full",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "full"
                                            ]
                                        },
                                        "description": "Returns the paginated list of cashback cards with their full data."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 1231231,\n            \"assetId\": \"CD6DFF867546665D83BE82BC10E81FE020C0234524t4494AD8C15D87759BFB4\",\n            \"wallet\": 123,\n            \"order\": 121212,\n            \"store\": 100,\n            \"campaign\": 123,\n            \"client\": 123123,\n            \"rewardType\": \"monetary\",\n            \"pointsDividend\": 1,\n            \"pointsDivisor\": 1,\n            \"aggregation_mode\": \"aggregate\",\n            \"totalCredit\": 15670,\n            \"amount\": 15670,\n            \"canceledAt\": null,\n            \"startsAt\": \"2026-04-24T00:00:00-06:00\",\n            \"expiresAt\": \"2026-05-24T23:59:59-06:00\",\n            \"createAt\": \"2026-04-23T13:52:43-06:00\",\n            \"updateAt\": \"2026-04-23T13:52:43-06:00\",\n            \"flow\": [\n                {\n                    \"tid\": \"10e3c61360e3db6a4f6b48ce8e586346e3rted24b656fe1e8a9a259d255f833\",\n                    \"cashBackCard\": 1233245,\n                    \"operation\": \"credit\",\n                    \"type\": \"reward\",\n                    \"value\": 15670,\n                    \"amount\": 15670,\n                    \"order\": 121212,\n                    \"coupon\": null,\n                    \"createAt\": \"2026-04-23T13:52:43-06:00\"\n                }\n            ],\n            \"cardId\": 1233245,\n            \"storeId\": 100,\n            \"operate\": \"credit\",\n            \"status\": \"standby\",\n            \"walletId\": 123,\n            \"orderId\": 121212,\n            \"campaignId\": 445,\n            \"campaignName\": \"Cashback Silver - Outlet\",\n            \"customerId\": 12332,\n            \"initialBalance\": 15670,\n            \"availableBalance\": 15670,\n            \"availableAt\": \"2026-04-24T00:00:00-06:00\",\n            \"updatedAt\": \"2026-04-23T13:52:43-06:00\",\n            \"redeemed_by_orderId\": null,\n            \"redeemed_by_couponId\": null,\n            \"redeemed_value\": null,\n            \"redeemedAt\": null,\n            \"redeemed_storeId\": null\n        }\n    ],\n    \"total\": 1,\n    \"pagination\": {\n        \"entries\": 50,\n        \"order\": [],\n        \"totalPages\": 1,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": true,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 0\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Reactivate Card",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/reactivate",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cards",
                                        "{{id}}",
                                        "reactivate"
                                    ]
                                },
                                "description": "Reverts a cancellation: clears the card's cancellation timestamp and puts it back in\ncirculation. This is the way back from [Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel).\n\nValidity is **not** touched. A card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt` - reactivating is not extending. The response carries the\nresulting `cardStatus`, so the caller sees whether the card is actually usable again.\n\nA card that is not canceled is refused with `409`."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/reactivate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "{{id}}",
                                                "reactivate"
                                            ]
                                        },
                                        "description": "Reverts a cancellation: clears the card's cancellation timestamp and puts it back in\ncirculation. This is the way back from [Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel).\n\nValidity is **not** touched. A card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt` - reactivating is not extending. The response carries the\nresulting `cardStatus`, so the caller sees whether the card is actually usable again.\n\nA card that is not canceled is refused with `409`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"cardId\": 95980,\n    \"canceledAt\": null,\n    \"cardStatus\": \"active\",\n    \"amount\": 1250\n}"
                                },
                                {
                                    "name": "No card with this id in the organization.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/reactivate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "{{id}}",
                                                "reactivate"
                                            ]
                                        },
                                        "description": "Reverts a cancellation: clears the card's cancellation timestamp and puts it back in\ncirculation. This is the way back from [Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel).\n\nValidity is **not** touched. A card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt` - reactivating is not extending. The response carries the\nresulting `cardStatus`, so the caller sees whether the card is actually usable again.\n\nA card that is not canceled is refused with `409`."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Card is not canceled.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/{{id}}/reactivate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "{{id}}",
                                                "reactivate"
                                            ]
                                        },
                                        "description": "Reverts a cancellation: clears the card's cancellation timestamp and puts it back in\ncirculation. This is the way back from [Cancel Card](/docs/{lang}/api-reference/loyalty/card/cancel).\n\nValidity is **not** touched. A card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt` - reactivating is not extending. The response carries the\nresulting `cardStatus`, so the caller sees whether the card is actually usable again.\n\nA card that is not canceled is refused with `409`."
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Reactivate Cards in Batch",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/reactivate",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cards",
                                        "reactivate"
                                    ]
                                },
                                "description": "Reverts the cancellation of up to 100 cards in one call - the way back from\n[Cancel Cards in Batch](/docs/{lang}/api-reference/loyalty/card/cancel-batch). Without it,\nundoing a batch of 100 would be 100 calls.\n\nSame shape as the batch cancel: `200` with the outcome of each item, and `400` only for a\nmalformed request. Outcomes here are `reactivated`, `not_canceled` (the card was not\ncanceled, nothing done) and `not_found`. The summary carries `amountRestored` - how much\nbalance returns to circulation.\n\nValidity is **not** touched: a card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt`. Reactivating is not extending.\n\n`dryRun` works the same way as in the batch cancel.\n\nA range never crosses organizations: an id that belongs to another account comes back\n`not_found` and is left untouched - every query here is scoped by organization.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"ids\": \"1512200:1512299;1512305;1512310\",\n    \"dryRun\": false\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Processed - read `results` for the outcome of each id.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/reactivate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "reactivate"
                                            ]
                                        },
                                        "description": "Reverts the cancellation of up to 100 cards in one call - the way back from\n[Cancel Cards in Batch](/docs/{lang}/api-reference/loyalty/card/cancel-batch). Without it,\nundoing a batch of 100 would be 100 calls.\n\nSame shape as the batch cancel: `200` with the outcome of each item, and `400` only for a\nmalformed request. Outcomes here are `reactivated`, `not_canceled` (the card was not\ncanceled, nothing done) and `not_found`. The summary carries `amountRestored` - how much\nbalance returns to circulation.\n\nValidity is **not** touched: a card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt`. Reactivating is not extending.\n\n`dryRun` works the same way as in the batch cancel.\n\nA range never crosses organizations: an id that belongs to another account comes back\n`not_found` and is left untouched - every query here is scoped by organization.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"ids\": \"1512200:1512299;1512305;1512310\",\n    \"dryRun\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"batchId\": \"cb_a17c40e9b882\",\n    \"dryRun\": false,\n    \"summary\": {\n        \"requested\": 3,\n        \"canceled\": 0,\n        \"reactivated\": 2,\n        \"already_canceled\": 0,\n        \"not_canceled\": 1,\n        \"has_open_reservation\": 0,\n        \"not_found\": 0,\n        \"amountRestored\": 62400\n    },\n    \"results\": [\n        { \"id\": 1512200, \"outcome\": \"reactivated\", \"amount\": 31200 },\n        { \"id\": 1512201, \"outcome\": \"reactivated\", \"amount\": 31200 },\n        { \"id\": 1512202, \"outcome\": \"not_canceled\" }\n    ]\n}"
                                },
                                {
                                    "name": "Malformed request: `ids` missing or empty, more than 100 ids, or a non-numeric id.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cards/reactivate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cards",
                                                "reactivate"
                                            ]
                                        },
                                        "description": "Reverts the cancellation of up to 100 cards in one call - the way back from\n[Cancel Cards in Batch](/docs/{lang}/api-reference/loyalty/card/cancel-batch). Without it,\nundoing a batch of 100 would be 100 calls.\n\nSame shape as the batch cancel: `200` with the outcome of each item, and `400` only for a\nmalformed request. Outcomes here are `reactivated`, `not_canceled` (the card was not\ncanceled, nothing done) and `not_found`. The summary carries `amountRestored` - how much\nbalance returns to circulation.\n\nValidity is **not** touched: a card reactivated after its `expiresAt` comes back expired,\nwith the original `expiresAt`. Reactivating is not extending.\n\n`dryRun` works the same way as in the batch cancel.\n\nA range never crosses organizations: an id that belongs to another account comes back\n`not_found` and is left untouched - every query here is scoped by organization.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"ids\": \"1512200:1512299;1512305;1512310\",\n    \"dryRun\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Checkout",
                    "item": [
                        {
                            "name": "Cancel Transaction and Order",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelOrderByTransaction/{{TID}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cancelOrderByTransaction",
                                        "{{TID}}"
                                    ]
                                },
                                "description": "Cancels both the loyalty transaction and its order — refunds cashback that was earned and rolls back any redeemed reward. Use when the entire purchase is being reverted."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelOrderByTransaction/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelOrderByTransaction",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels both the loyalty transaction and its order — refunds cashback that was earned and rolls back any redeemed reward. Use when the entire purchase is being reverted."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"TID\": \"dcf33b4448d604033d12ce176253ee54851531212b29bde1468d359e82005b92\",\n    \"order\": 2467383,\n    \"reward\": [\n        {\n            \"cardId\": 185840,\n            \"value\": 0\n        }\n    ],\n    \"redemption\": [\n        {\n            \"cardId\": 185839,\n            \"value\": 1099\n        }\n    ]\n}"
                                },
                                {
                                    "name": "Was canceled",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelOrderByTransaction/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelOrderByTransaction",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels both the loyalty transaction and its order — refunds cashback that was earned and rolls back any redeemed reward. Use when the entire purchase is being reverted."
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\": 409,\n    \"reason_phrase\": \"Transaction was canceled\",\n    \"message\": \"This transaction was canceled previously\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Confirm Order by confirmToken",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/confirmOrder/{{confirmToken}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "confirmOrder",
                                        "{{confirmToken}}"
                                    ]
                                },
                                "description": "Confirms a pending transaction using the `confirmToken` returned by Reward by Order.\nApplies the rewards permanently and records the final sale.\n\nMonetary fields (`amountToRedeem`, payment `value`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values) for the convention.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": \"order-12345\",\n    \"amountToRedeem\": null,\n    \"waitSettlement\": false,\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"name\": \"Tintim\"\n    },\n    \"payments\": [\n        {\n            \"paymentSystem\": \"4\",\n            \"paymentSystemName\": \"Mastercard\",\n            \"type\": \"creditCard\",\n            \"value\": 5447,\n            \"installments\": 3,\n            \"firstDigits\": \"550209\",\n            \"lastDigits\": \"2569\"\n        }\n    ]\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success — customer identified",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/confirmOrder/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "confirmOrder",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Confirms a pending transaction using the `confirmToken` returned by Reward by Order.\nApplies the rewards permanently and records the final sale.\n\nMonetary fields (`amountToRedeem`, payment `value`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values) for the convention.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": \"order-12345\",\n    \"amountToRedeem\": null,\n    \"waitSettlement\": false,\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"name\": \"Tintim\"\n    },\n    \"payments\": [\n        {\n            \"paymentSystem\": \"4\",\n            \"paymentSystemName\": \"Mastercard\",\n            \"type\": \"creditCard\",\n            \"value\": 5447,\n            \"installments\": 3,\n            \"firstDigits\": \"550209\",\n            \"lastDigits\": \"2569\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"orderId\": \"456\",\n    \"TID\": \"54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49\",\n    \"customerId\": 570971,\n    \"person\": 570971,\n    \"cashback\": {\n        \"redeemedOrder\": 12500,\n        \"accumulatedOrder\": 96390\n    },\n    \"confirmedAt\": \"2025-01-15T16:21:39-03:00\",\n    \"dateTime\": \"2025-01-15T16:21:44-03:00\"\n}"
                                },
                                {
                                    "name": "Success — anonymous sale (no customer identified).\n\nWith no customer there is no one to credit, so no reward card is created.\nThe response reflects that: `customerId` and `person` are **omitted**, and\nboth `cashback` values come back `0`. Do not read the accumulation from\nthis response as a credited amount — for what the customer actually\naccumulated, use the reward card endpoints.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/confirmOrder/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "confirmOrder",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Confirms a pending transaction using the `confirmToken` returned by Reward by Order.\nApplies the rewards permanently and records the final sale.\n\nMonetary fields (`amountToRedeem`, payment `value`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values) for the convention.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": \"order-12345\",\n    \"amountToRedeem\": null,\n    \"waitSettlement\": false,\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"name\": \"Tintim\"\n    },\n    \"payments\": [\n        {\n            \"paymentSystem\": \"4\",\n            \"paymentSystemName\": \"Mastercard\",\n            \"type\": \"creditCard\",\n            \"value\": 5447,\n            \"installments\": 3,\n            \"firstDigits\": \"550209\",\n            \"lastDigits\": \"2569\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"orderId\": \"456\",\n    \"TID\": \"54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49\",\n    \"cashback\": {\n        \"redeemedOrder\": 0,\n        \"accumulatedOrder\": 0\n    },\n    \"confirmedAt\": \"2025-01-15T16:21:39-03:00\",\n    \"dateTime\": \"2025-01-15T16:21:44-03:00\"\n}"
                                },
                                {
                                    "name": "Missing `confirmToken` in URL or `id` in body.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/confirmOrder/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "confirmOrder",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Confirms a pending transaction using the `confirmToken` returned by Reward by Order.\nApplies the rewards permanently and records the final sale.\n\nMonetary fields (`amountToRedeem`, payment `value`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values) for the convention.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": \"order-12345\",\n    \"amountToRedeem\": null,\n    \"waitSettlement\": false,\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"name\": \"Tintim\"\n    },\n    \"payments\": [\n        {\n            \"paymentSystem\": \"4\",\n            \"paymentSystemName\": \"Mastercard\",\n            \"type\": \"creditCard\",\n            \"value\": 5447,\n            \"installments\": 3,\n            \"firstDigits\": \"550209\",\n            \"lastDigits\": \"2569\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "The provided `confirmToken` does not belong to an existing prediction.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/confirmOrder/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "confirmOrder",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Confirms a pending transaction using the `confirmToken` returned by Reward by Order.\nApplies the rewards permanently and records the final sale.\n\nMonetary fields (`amountToRedeem`, payment `value`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values) for the convention.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": \"order-12345\",\n    \"amountToRedeem\": null,\n    \"waitSettlement\": false,\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"name\": \"Tintim\"\n    },\n    \"payments\": [\n        {\n            \"paymentSystem\": \"4\",\n            \"paymentSystemName\": \"Mastercard\",\n            \"type\": \"creditCard\",\n            \"value\": 5447,\n            \"installments\": 3,\n            \"firstDigits\": \"550209\",\n            \"lastDigits\": \"2569\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "The order has already been confirmed or the confirmation period has expired.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/confirmOrder/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "confirmOrder",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Confirms a pending transaction using the `confirmToken` returned by Reward by Order.\nApplies the rewards permanently and records the final sale.\n\nMonetary fields (`amountToRedeem`, payment `value`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values) for the convention.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": \"order-12345\",\n    \"amountToRedeem\": null,\n    \"waitSettlement\": false,\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"name\": \"Tintim\"\n    },\n    \"payments\": [\n        {\n            \"paymentSystem\": \"4\",\n            \"paymentSystemName\": \"Mastercard\",\n            \"type\": \"creditCard\",\n            \"value\": 5447,\n            \"installments\": 3,\n            \"firstDigits\": \"550209\",\n            \"lastDigits\": \"2569\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Partial cancellation",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "cancelPartial",
                                        "{{TID}}"
                                    ]
                                },
                                "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelPartial",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"TID\": \"6ea795c61088f27baa304d3dce8e4e7a85b99f78378d1101dbfc82864759e798\",\n    \"redemption\": [\n        { \"cardId\": 331467, \"value\": \"949\" },\n        { \"cardId\": 331471, \"value\": \"1748\" },\n        { \"cardId\": 331486, \"value\": \"3432\" }\n    ],\n    \"reward\": [\n        { \"cardId\": 331532, \"value\": 1601 },\n        { \"cardId\": 331533, \"value\": 6574 }\n    ]\n}"
                                },
                                {
                                    "name": "Missing `items` in body or missing `hash`/`TID` in URL.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelPartial",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Transaction not found for the given `TID`, or the order behind it no longer exists.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelPartial",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "The same `id` appears in multiple lines with different unit prices and `price` was omitted, so the line to cancel is ambiguous. Re-send the item with `price`.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelPartial",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\": 409,\n    \"reason_phrase\": \"Conflict\",\n    \"message\": \"Item (7702781260484) has multiple lines with different prices; inform 'price' to select which one\"\n}"
                                },
                                {
                                    "name": "The requested quantity is larger than what is still uncancelled for that item.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelPartial",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\": 409,\n    \"reason_phrase\": \"Conflict\",\n    \"message\": \"Item (7702781260484) has more items than available to cancel.\"\n}"
                                },
                                {
                                    "name": "The `id` was not part of this transaction, or the `price` sent does not match any line of the order.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/cancelPartial/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "cancelPartial",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels specific items from a confirmed transaction. Returns the redemption (cashback)\nthat should be refunded to the customer and reverts the reward (cashback) generated for\nthose items.\n\nItems are matched by `id` (SKU) and, when needed, by `price` — never by the position of the\nitem inside the request. When the same `id` appears in more than one line of the order:\n\n- **All lines share the same unit price** — `price` is optional. Lines are consumed in the\n  order they were sent in `rewardByOrder`, so cancelling one unit takes the first line that\n  still has an uncancelled quantity. The lines are interchangeable, so the refund is the same\n  whichever one is picked.\n- **The lines have different unit prices** — `price` becomes **required**. Without it the\n  request fails with `409` instead of guessing a line, since cancelling the wrong line would\n  refund the wrong amount.\n\nRe-sending every item of the original purchase remains the safest approach.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"status_code\": 409,\n    \"reason_phrase\": \"Conflict\",\n    \"message\": \"Item (7702781260484) not found\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Promotion by Order",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/getPromotion",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "getPromotion"
                                    ]
                                },
                                "description": "Calculates promotional discounts that apply to a given order. Each organization may have\none or more active campaigns evaluated in priority order — the response lists every\ndiscount that fired for the cart.\n\nThis endpoint accepts the same body shape as `rewardByOrder` (see [Reward by Order](../reward-by-order))\nand operates in two modes: **Public** (omit `x-guper-authorization`) and **Private**.\nMonetary fields (`price`, `listPrice`, `tax`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"sip\",\n    \"storeId\": \"1\",\n    \"client\": \"<client>\",\n    \"items\": [\n        {\n            \"id\": \"2\",\n            \"productId\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"categoryId\": \"20\",\n            \"brandId\": \"20\",\n            \"sellerId\": \"1\",\n            \"collection\": [\n                347,\n                336\n            ],\n            \"tax\": 1232,\n            \"quantity\": 2,\n            \"price\": 96390,\n            \"listPrice\": 100000\n        }\n    ],\n    \"shipping\": \"<shipping>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success — returns every discount that applied. `discount` is empty when no campaign matched.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/getPromotion",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "getPromotion"
                                            ]
                                        },
                                        "description": "Calculates promotional discounts that apply to a given order. Each organization may have\none or more active campaigns evaluated in priority order — the response lists every\ndiscount that fired for the cart.\n\nThis endpoint accepts the same body shape as `rewardByOrder` (see [Reward by Order](../reward-by-order))\nand operates in two modes: **Public** (omit `x-guper-authorization`) and **Private**.\nMonetary fields (`price`, `listPrice`, `tax`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"sip\",\n    \"storeId\": \"1\",\n    \"client\": \"<client>\",\n    \"items\": [\n        {\n            \"id\": \"2\",\n            \"productId\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"categoryId\": \"20\",\n            \"brandId\": \"20\",\n            \"sellerId\": \"1\",\n            \"collection\": [\n                347,\n                336\n            ],\n            \"tax\": 1232,\n            \"quantity\": 2,\n            \"price\": 96390,\n            \"listPrice\": 100000\n        }\n    ],\n    \"shipping\": \"<shipping>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"discount\": [\n        {\n            \"campaign\": \"NEWPROGRESSIVE2025\",\n            \"description\": \"Desconto por quantidade de itens\",\n            \"total\": 38556,\n            \"item\": [\n                { \"id\": \"2\", \"position\": 0, \"value\": 19278, \"quantity\": 2 },\n                { \"id\": \"3\", \"position\": 1, \"value\": 19278, \"quantity\": 1 }\n            ]\n        }\n    ]\n}"
                                },
                                {
                                    "name": "Invalid or malformed JSON body.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/getPromotion",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "getPromotion"
                                            ]
                                        },
                                        "description": "Calculates promotional discounts that apply to a given order. Each organization may have\none or more active campaigns evaluated in priority order — the response lists every\ndiscount that fired for the cart.\n\nThis endpoint accepts the same body shape as `rewardByOrder` (see [Reward by Order](../reward-by-order))\nand operates in two modes: **Public** (omit `x-guper-authorization`) and **Private**.\nMonetary fields (`price`, `listPrice`, `tax`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"sip\",\n    \"storeId\": \"1\",\n    \"client\": \"<client>\",\n    \"items\": [\n        {\n            \"id\": \"2\",\n            \"productId\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"categoryId\": \"20\",\n            \"brandId\": \"20\",\n            \"sellerId\": \"1\",\n            \"collection\": [\n                347,\n                336\n            ],\n            \"tax\": 1232,\n            \"quantity\": 2,\n            \"price\": 96390,\n            \"listPrice\": 100000\n        }\n    ],\n    \"shipping\": \"<shipping>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Reward by Order — Private",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/rewardByOrder",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "rewardByOrder"
                                    ]
                                },
                                "description": "Returns customer data, redeemable reward information and a confirmation token\nyou can later send to `confirmOrder`. Requires a valid user token.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"checkoutId\": \"ck_demo_a1b2-c3d4\",\n    \"purchaseType\": \"delivery\",\n    \"client\": {\n        \"id\": \"123123\",\n        \"name\": \"Tintim\",\n        \"document\": \"32165987\",\n        \"email\": \"tintim@guper.co\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\"\n    },\n    \"attendants\": {\n        \"cashier\": {\n            \"id\": \"123\"\n        },\n        \"salesperson\": {\n            \"id\": \"342\"\n        }\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"productId\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"categoryId\": \"20\",\n            \"brandId\": \"20\",\n            \"sellerId\": \"1\",\n            \"tax\": 1232,\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000\n        }\n    ],\n    \"shipping\": [\n        {\n            \"id\": \"AA123456785BR\",\n            \"courierId\": \"correios-br\",\n            \"courierName\": \"Correios\",\n            \"price\": 2000,\n            \"listPrice\": 2000\n        }\n    ]\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/rewardByOrder",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "rewardByOrder"
                                            ]
                                        },
                                        "description": "Returns customer data, redeemable reward information and a confirmation token\nyou can later send to `confirmOrder`. Requires a valid user token.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"checkoutId\": \"ck_demo_a1b2-c3d4\",\n    \"purchaseType\": \"delivery\",\n    \"client\": {\n        \"id\": \"123123\",\n        \"name\": \"Tintim\",\n        \"document\": \"32165987\",\n        \"email\": \"tintim@guper.co\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\"\n    },\n    \"attendants\": {\n        \"cashier\": {\n            \"id\": \"123\"\n        },\n        \"salesperson\": {\n            \"id\": \"342\"\n        }\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"productId\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"categoryId\": \"20\",\n            \"brandId\": \"20\",\n            \"sellerId\": \"1\",\n            \"tax\": 1232,\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000\n        }\n    ],\n    \"shipping\": [\n        {\n            \"id\": \"AA123456785BR\",\n            \"courierId\": \"correios-br\",\n            \"courierName\": \"Correios\",\n            \"price\": 2000,\n            \"listPrice\": 2000\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"interface\": \"generic\",\n    \"customerId\": 708,\n    \"cashback\": {\n        \"thisOrder\": {\n            \"redeemable\": {\n                \"total\": 522,\n                \"item\": [{ \"id\": \"1\", \"value\": 522 }]\n            },\n            \"accumulating\": {\n                \"total\": 4819,\n                \"item\": [{ \"id\": \"1\", \"value\": 4819 }]\n            }\n        },\n        \"userBalance\": { \"total\": 0, \"availableAmount\": 0 }\n    },\n    \"confirmToken\": \"54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49\",\n    \"smartpos\": \"https://acme.myguper.com/smartpos/54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49\",\n    \"expiresAt\": \"2024-05-21T11:21:27-03:00\",\n    \"dateTime\": \"2024-05-21T10:51:27-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Reward by Order — Public",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/rewardByOrder",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "rewardByOrder"
                                    ]
                                },
                                "description": "Returns only the cashback that *will* accumulate for this order — no\ncustomer data and no confirmation token. No authentication required.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/rewardByOrder",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "rewardByOrder"
                                            ]
                                        },
                                        "description": "Returns only the cashback that *will* accumulate for this order — no\ncustomer data and no confirmation token. No authentication required.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"interface\": \"generic\",\n    \"cashback\": {\n        \"thisOrder\": {\n            \"accumulating\": { \"total\": 9639 }\n        }\n    },\n    \"expiresAt\": \"2024-05-21T11:30:37-03:00\",\n    \"dateTime\": \"2024-05-21T11:00:37-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Transaction Settlement",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/transactionSettlement/{{TID}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "transactionSettlement",
                                        "{{TID}}"
                                    ]
                                },
                                "description": "Settles a transaction by TID — finalises pending accumulation and redemption so balances\nbecome available to the customer.\n\nThis is the **explicit** way to finalize a transaction that was confirmed with\n`waitSettlement: true` (see [Confirm Order by confirmToken](/docs/{lang}/api-reference/loyalty/checkout/confirm-order-by-confirmtoken)):\nit credits the rewards and settles the reservation. A held transaction is also finalized\n**automatically** when its order reaches a final state — completed (rewards credited) or\ncanceled (reservation released and any pending reward rolled back) — so calling this\nendpoint is only required when you drive settlement yourself instead of relying on the\norder flow."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/transactionSettlement/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "transactionSettlement",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Settles a transaction by TID — finalises pending accumulation and redemption so balances\nbecome available to the customer.\n\nThis is the **explicit** way to finalize a transaction that was confirmed with\n`waitSettlement: true` (see [Confirm Order by confirmToken](/docs/{lang}/api-reference/loyalty/checkout/confirm-order-by-confirmtoken)):\nit credits the rewards and settles the reservation. A held transaction is also finalized\n**automatically** when its order reaches a final state — completed (rewards credited) or\ncanceled (reservation released and any pending reward rolled back) — so calling this\nendpoint is only required when you drive settlement yourself instead of relying on the\norder flow."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Update Transaction",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/updateTransaction/{{confirmToken}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "updateTransaction",
                                        "{{confirmToken}}"
                                    ]
                                },
                                "description": "Updates a pending transaction (items, totals, customer, payments) before confirmation.\nRecalculates redeemable and accumulating cashback so the next `confirmOrder` uses the new\nvalues.\n\nBoth `recalculateReward` and `recalculateRedemption` default to `true` — set them to `false`\nto keep the original calculation when sending only metadata changes (e.g. updating items\nwithout re-running the cashback rules). Monetary fields (`price`, `listPrice`, `tax`,\n`amountToRedeem`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"recalculateReward\": true,\n    \"recalculateRedemption\": true,\n    \"amountToRedeem\": null,\n    \"items\": [\n        {\n            \"skuId\": \"1\",\n            \"quantity\": 1,\n            \"price\": 90000,\n            \"listPrice\": 100000,\n            \"tax\": 1232\n        }\n    ],\n    \"payments\": \"<payments>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success — returns the recalculated prediction (cashback, balance, confirmToken).",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/updateTransaction/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "updateTransaction",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Updates a pending transaction (items, totals, customer, payments) before confirmation.\nRecalculates redeemable and accumulating cashback so the next `confirmOrder` uses the new\nvalues.\n\nBoth `recalculateReward` and `recalculateRedemption` default to `true` — set them to `false`\nto keep the original calculation when sending only metadata changes (e.g. updating items\nwithout re-running the cashback rules). Monetary fields (`price`, `listPrice`, `tax`,\n`amountToRedeem`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"recalculateReward\": true,\n    \"recalculateRedemption\": true,\n    \"amountToRedeem\": null,\n    \"items\": [\n        {\n            \"skuId\": \"1\",\n            \"quantity\": 1,\n            \"price\": 90000,\n            \"listPrice\": 100000,\n            \"tax\": 1232\n        }\n    ],\n    \"payments\": \"<payments>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"xpto\",\n    \"interface\": \"generic\",\n    \"customerId\": 2157344,\n    \"cashback\": {\n        \"thisOrder\": {\n            \"redeemable\": {\n                \"total\": 55059,\n                \"item\": [\n                    { \"skuId\": \"2\",  \"value\": 18353 },\n                    { \"skuId\": \"10\", \"value\": 18353 },\n                    { \"skuId\": \"10\", \"value\": 18353 }\n                ]\n            },\n            \"accumulating\": {\n                \"total\": 54464,\n                \"item\": [\n                    { \"skuId\": \"2\",  \"value\": 18155 },\n                    { \"skuId\": \"10\", \"value\": 18155 },\n                    { \"skuId\": \"10\", \"value\": 18154 }\n                ]\n            }\n        },\n        \"userBalance\": { \"total\": 55059, \"availableAmount\": 54464 }\n    },\n    \"coupon\": [],\n    \"confirmToken\": \"ca93b522eb10c42dff16ce8d5b3ad86d962a610184db68643158eec9bb10747f\",\n    \"expiresAt\": \"2025-07-25T00:52:14-06:00\",\n    \"smartpos\": \"https://xpto.myguper.com/smartpos/ca93b522eb10c42dff16ce8d5b3ad86d962a610184db68643158eec9bb10747f\",\n    \"dateTime\": \"2025-07-24T12:52:14-06:00\"\n}"
                                },
                                {
                                    "name": "`confirmToken` not found or missing in URL.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/updateTransaction/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "updateTransaction",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Updates a pending transaction (items, totals, customer, payments) before confirmation.\nRecalculates redeemable and accumulating cashback so the next `confirmOrder` uses the new\nvalues.\n\nBoth `recalculateReward` and `recalculateRedemption` default to `true` — set them to `false`\nto keep the original calculation when sending only metadata changes (e.g. updating items\nwithout re-running the cashback rules). Monetary fields (`price`, `listPrice`, `tax`,\n`amountToRedeem`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"recalculateReward\": true,\n    \"recalculateRedemption\": true,\n    \"amountToRedeem\": null,\n    \"items\": [\n        {\n            \"skuId\": \"1\",\n            \"quantity\": 1,\n            \"price\": 90000,\n            \"listPrice\": 100000,\n            \"tax\": 1232\n        }\n    ],\n    \"payments\": \"<payments>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "The order has already been confirmed or expired.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/updateTransaction/{{confirmToken}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "updateTransaction",
                                                "{{confirmToken}}"
                                            ]
                                        },
                                        "description": "Updates a pending transaction (items, totals, customer, payments) before confirmation.\nRecalculates redeemable and accumulating cashback so the next `confirmOrder` uses the new\nvalues.\n\nBoth `recalculateReward` and `recalculateRedemption` default to `true` — set them to `false`\nto keep the original calculation when sending only metadata changes (e.g. updating items\nwithout re-running the cashback rules). Monetary fields (`price`, `listPrice`, `tax`,\n`amountToRedeem`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"recalculateReward\": true,\n    \"recalculateRedemption\": true,\n    \"amountToRedeem\": null,\n    \"items\": [\n        {\n            \"skuId\": \"1\",\n            \"quantity\": 1,\n            \"price\": 90000,\n            \"listPrice\": 100000,\n            \"tax\": 1232\n        }\n    ],\n    \"payments\": \"<payments>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Coupons",
                    "item": [
                        {
                            "name": "Reserve",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{transactionId}}/reserve",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "coupon",
                                        "{{transactionId}}",
                                        "reserve"
                                    ]
                                },
                                "description": "Reserves a coupon code from a coupon batch (`couponBatchId`) for a specific transaction.\nPicks an available code from the batch, computes the discount based on the batch\nconfiguration (fixed or percent over `total_item`), and reserves the redemption against\nthe transaction (`transactionId` is the `confirmToken`).\n\nUse [Coupon search](../search) first to find a compatible batch for the cart, then call\nthis endpoint with the chosen `couponBatchId`. Settle the coupon with [Coupon settlement](../settlement)\nafter the order is placed.\n\nMonetary fields (`total_item`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"couponBatchId\": 123,\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"clientId\": 123,\n    \"total_item\": 96390\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success — returns the reserved coupon code with its computed `couponValue`.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{transactionId}}/reserve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{transactionId}}",
                                                "reserve"
                                            ]
                                        },
                                        "description": "Reserves a coupon code from a coupon batch (`couponBatchId`) for a specific transaction.\nPicks an available code from the batch, computes the discount based on the batch\nconfiguration (fixed or percent over `total_item`), and reserves the redemption against\nthe transaction (`transactionId` is the `confirmToken`).\n\nUse [Coupon search](../search) first to find a compatible batch for the cart, then call\nthis endpoint with the chosen `couponBatchId`. Settle the coupon with [Coupon settlement](../settlement)\nafter the order is placed.\n\nMonetary fields (`total_item`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"couponBatchId\": 123,\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"clientId\": 123,\n    \"total_item\": 96390\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Required body fields missing or `transactionId` missing in URL.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{transactionId}}/reserve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{transactionId}}",
                                                "reserve"
                                            ]
                                        },
                                        "description": "Reserves a coupon code from a coupon batch (`couponBatchId`) for a specific transaction.\nPicks an available code from the batch, computes the discount based on the batch\nconfiguration (fixed or percent over `total_item`), and reserves the redemption against\nthe transaction (`transactionId` is the `confirmToken`).\n\nUse [Coupon search](../search) first to find a compatible batch for the cart, then call\nthis endpoint with the chosen `couponBatchId`. Settle the coupon with [Coupon settlement](../settlement)\nafter the order is placed.\n\nMonetary fields (`total_item`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"couponBatchId\": 123,\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"clientId\": 123,\n    \"total_item\": 96390\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Coupon batch not found.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{transactionId}}/reserve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{transactionId}}",
                                                "reserve"
                                            ]
                                        },
                                        "description": "Reserves a coupon code from a coupon batch (`couponBatchId`) for a specific transaction.\nPicks an available code from the batch, computes the discount based on the batch\nconfiguration (fixed or percent over `total_item`), and reserves the redemption against\nthe transaction (`transactionId` is the `confirmToken`).\n\nUse [Coupon search](../search) first to find a compatible batch for the cart, then call\nthis endpoint with the chosen `couponBatchId`. Settle the coupon with [Coupon settlement](../settlement)\nafter the order is placed.\n\nMonetary fields (`total_item`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"couponBatchId\": 123,\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"clientId\": 123,\n    \"total_item\": 96390\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "No codes available in the batch, or the transaction cannot be confirmed.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{transactionId}}/reserve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{transactionId}}",
                                                "reserve"
                                            ]
                                        },
                                        "description": "Reserves a coupon code from a coupon batch (`couponBatchId`) for a specific transaction.\nPicks an available code from the batch, computes the discount based on the batch\nconfiguration (fixed or percent over `total_item`), and reserves the redemption against\nthe transaction (`transactionId` is the `confirmToken`).\n\nUse [Coupon search](../search) first to find a compatible batch for the cart, then call\nthis endpoint with the chosen `couponBatchId`. Settle the coupon with [Coupon settlement](../settlement)\nafter the order is placed.\n\nMonetary fields (`total_item`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"couponBatchId\": 123,\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"clientId\": 123,\n    \"total_item\": 96390\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Search Coupon by code — find a discount / promo code",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/search",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "coupon",
                                        "search"
                                    ]
                                },
                                "description": "Returns the best coupon batch for the current cart based on the active redemption policy.\nThe service:\n\n1. Lists all coupon batches available for the store's policy.\n2. Computes the discount each batch would generate (`fixed` value or percent over `total_item`).\n3. Picks the highest-pass match (the lowest discount that still covers `redeemableTotal`).\n   If no batch covers it, falls back to the closest low-pass match (the highest discount under\n   `redeemableTotal`).\n\nUse the returned `couponBatchId` with [Coupon reserve](../reserve) to lock a code for the\ntransaction. Monetary fields (`total_item`, `redeemableTotal`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"total_item\": 25000,\n    \"redeemableTotal\": 25000\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "search"
                                            ]
                                        },
                                        "description": "Returns the best coupon batch for the current cart based on the active redemption policy.\nThe service:\n\n1. Lists all coupon batches available for the store's policy.\n2. Computes the discount each batch would generate (`fixed` value or percent over `total_item`).\n3. Picks the highest-pass match (the lowest discount that still covers `redeemableTotal`).\n   If no batch covers it, falls back to the closest low-pass match (the highest discount under\n   `redeemableTotal`).\n\nUse the returned `couponBatchId` with [Coupon reserve](../reserve) to lock a code for the\ntransaction. Monetary fields (`total_item`, `redeemableTotal`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"total_item\": 25000,\n    \"redeemableTotal\": 25000\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"couponBatchId\": 2,\n    \"policy\": 14,\n    \"description\": \"Test\",\n    \"type\": \"fixed\",\n    \"value\": 30000,\n    \"discount\": 30000\n}"
                                },
                                {
                                    "name": "No coupon batch found for the policy or no compatible discount.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "search"
                                            ]
                                        },
                                        "description": "Returns the best coupon batch for the current cart based on the active redemption policy.\nThe service:\n\n1. Lists all coupon batches available for the store's policy.\n2. Computes the discount each batch would generate (`fixed` value or percent over `total_item`).\n3. Picks the highest-pass match (the lowest discount that still covers `redeemableTotal`).\n   If no batch covers it, falls back to the closest low-pass match (the highest discount under\n   `redeemableTotal`).\n\nUse the returned `couponBatchId` with [Coupon reserve](../reserve) to lock a code for the\ntransaction. Monetary fields (`total_item`, `redeemableTotal`) are sent as **integer cents** —\nsee [Monetary values](/docs/{lang}/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"2\",\n    \"total_item\": 25000,\n    \"redeemableTotal\": 25000\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Coupon: Settlement",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{couponCode}}/settlement",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "coupon",
                                        "{{couponCode}}",
                                        "settlement"
                                    ]
                                },
                                "description": "Settles a coupon by `couponCode` — marks it as redeemed and binds it\nto the originating `orderId`. The (organization, interface, code)\ntriple must match a non-redeemed `coupon_codes` row; re-submitting a\ncode that has already been redeemed returns 409 Conflict.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"orderId\": \"VTEX-99182\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Coupon settled",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{couponCode}}/settlement",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{couponCode}}",
                                                "settlement"
                                            ]
                                        },
                                        "description": "Settles a coupon by `couponCode` — marks it as redeemed and binds it\nto the originating `orderId`. The (organization, interface, code)\ntriple must match a non-redeemed `coupon_codes` row; re-submitting a\ncode that has already been redeemed returns 409 Conflict.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"orderId\": \"VTEX-99182\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "No coupon code found with this couponCode",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{couponCode}}/settlement",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{couponCode}}",
                                                "settlement"
                                            ]
                                        },
                                        "description": "Settles a coupon by `couponCode` — marks it as redeemed and binds it\nto the originating `orderId`. The (organization, interface, code)\ntriple must match a non-redeemed `coupon_codes` row; re-submitting a\ncode that has already been redeemed returns 409 Conflict.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"orderId\": \"VTEX-99182\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Coupon already redeemed",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/coupon/{{couponCode}}/settlement",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "coupon",
                                                "{{couponCode}}",
                                                "settlement"
                                            ]
                                        },
                                        "description": "Settles a coupon by `couponCode` — marks it as redeemed and binds it\nto the originating `orderId`. The (organization, interface, code)\ntriple must match a non-redeemed `coupon_codes` row; re-submitting a\ncode that has already been redeemed returns 409 Conflict.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"orderId\": \"VTEX-99182\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": true, \"message\": \"This coupon has already been redeemed.\" }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "External event",
                    "item": [
                        {
                            "name": "External Event: Create Reward",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/external-event",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "external-event"
                                    ]
                                },
                                "description": "Issues reward cards driven by **external-events** campaigns — used when an\noutside system (CRM, app, e-mail) decides *when* and *how much* to reward,\nand Guper just creates the cards under the campaign's identity (validity,\ntags, sequence, messaging).\n\nThe campaign supplies the structure; the request body supplies the value.\nInternally the call overrides the campaign's `aliquot` with the `value`\nyou send, so each entry in `campaigns[]` produces exactly one reward card\nof the requested amount. Optional `startsAt` / `expiresAt` per entry\noverride the default availability window of the resulting card.\n\nAccepts a single campaign object `{ id, value }` or an array of objects\n— a single object is auto-wrapped.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"document\": \"<document>\",\n        \"name\": \"Tintim\"\n    },\n    \"campaigns\": [\n        {\n            \"id\": 7,\n            \"value\": 5000,\n            \"startsAt\": \"2026-05-08\",\n            \"expiresAt\": \"2027-05-08\"\n        }\n    ],\n    \"storeId\": \"<storeId>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Cards generated",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/external-event",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "external-event"
                                            ]
                                        },
                                        "description": "Issues reward cards driven by **external-events** campaigns — used when an\noutside system (CRM, app, e-mail) decides *when* and *how much* to reward,\nand Guper just creates the cards under the campaign's identity (validity,\ntags, sequence, messaging).\n\nThe campaign supplies the structure; the request body supplies the value.\nInternally the call overrides the campaign's `aliquot` with the `value`\nyou send, so each entry in `campaigns[]` produces exactly one reward card\nof the requested amount. Optional `startsAt` / `expiresAt` per entry\noverride the default availability window of the resulting card.\n\nAccepts a single campaign object `{ id, value }` or an array of objects\n— a single object is auto-wrapped.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"document\": \"<document>\",\n        \"name\": \"Tintim\"\n    },\n    \"campaigns\": [\n        {\n            \"id\": 7,\n            \"value\": 5000,\n            \"startsAt\": \"2026-05-08\",\n            \"expiresAt\": \"2027-05-08\"\n        }\n    ],\n    \"storeId\": \"<storeId>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"reward\": [\n        { \"TID\": \"54eb6281…\", \"campaign\": 7,  \"rewardValue\": 5000 },\n        { \"TID\": \"54eb6281…\", \"campaign\": 12, \"rewardValue\": 1000 }\n    ],\n    \"total\": 6000\n}"
                                },
                                {
                                    "name": "Body missing fields, invalid campaign, or campaign outside its window",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/external-event",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "external-event"
                                            ]
                                        },
                                        "description": "Issues reward cards driven by **external-events** campaigns — used when an\noutside system (CRM, app, e-mail) decides *when* and *how much* to reward,\nand Guper just creates the cards under the campaign's identity (validity,\ntags, sequence, messaging).\n\nThe campaign supplies the structure; the request body supplies the value.\nInternally the call overrides the campaign's `aliquot` with the `value`\nyou send, so each entry in `campaigns[]` produces exactly one reward card\nof the requested amount. Optional `startsAt` / `expiresAt` per entry\noverride the default availability window of the resulting card.\n\nAccepts a single campaign object `{ id, value }` or an array of objects\n— a single object is auto-wrapped.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"document\": \"<document>\",\n        \"name\": \"Tintim\"\n    },\n    \"campaigns\": [\n        {\n            \"id\": 7,\n            \"value\": 5000,\n            \"startsAt\": \"2026-05-08\",\n            \"expiresAt\": \"2027-05-08\"\n        }\n    ],\n    \"storeId\": \"<storeId>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"bad_request\", \"message\": \"Campaign is not of type external-events (id: 7)\" }"
                                },
                                {
                                    "name": "Interface, campaign or resolved client not found",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/external-event",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "external-event"
                                            ]
                                        },
                                        "description": "Issues reward cards driven by **external-events** campaigns — used when an\noutside system (CRM, app, e-mail) decides *when* and *how much* to reward,\nand Guper just creates the cards under the campaign's identity (validity,\ntags, sequence, messaging).\n\nThe campaign supplies the structure; the request body supplies the value.\nInternally the call overrides the campaign's `aliquot` with the `value`\nyou send, so each entry in `campaigns[]` produces exactly one reward card\nof the requested amount. Optional `startsAt` / `expiresAt` per entry\noverride the default availability window of the resulting card.\n\nAccepts a single campaign object `{ id, value }` or an array of objects\n— a single object is auto-wrapped.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"client\": {\n        \"id\": \"123123\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"tintim@guper.co\",\n        \"document\": \"<document>\",\n        \"name\": \"Tintim\"\n    },\n    \"campaigns\": [\n        {\n            \"id\": 7,\n            \"value\": 5000,\n            \"startsAt\": \"2026-05-08\",\n            \"expiresAt\": \"2027-05-08\"\n        }\n    ],\n    \"storeId\": \"<storeId>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"not_found\", \"message\": \"Client not found\" }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/loyalty/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "loyalty",
                                "ping"
                            ]
                        },
                        "description": "Resource for checking service availability"
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "ping"
                                    ]
                                },
                                "description": "Resource for checking service availability"
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"organization\": \"acme\",\n    \"response\": \"Server online\",\n    \"dateTime\": \"2023-08-11T13:58:07-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Redeem",
                    "item": [
                        {
                            "name": "Redeem: Reserve",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/redeem/reserve/{{hash}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "redeem",
                                        "reserve",
                                        "{{hash}}"
                                    ]
                                },
                                "description": "Reserves the redeemable amount tied to a previously calculated reward\npromise (the `hash`/`confirmToken` returned by [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)).\nThe reservation enters `waitSettlement` and points are held against the\ncustomer's balance until the order is confirmed (`reserved` → `cancelled`\nor `redeemed` via [Settle](/docs/{lang}/api-reference/loyalty/redeem/settle)).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"refId\": \"<refId>\",\n    \"reserve\": 0,\n    \"couponCode\": \"<couponCode>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Reservation accepted",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/redeem/reserve/{{hash}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "redeem",
                                                "reserve",
                                                "{{hash}}"
                                            ]
                                        },
                                        "description": "Reserves the redeemable amount tied to a previously calculated reward\npromise (the `hash`/`confirmToken` returned by [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)).\nThe reservation enters `waitSettlement` and points are held against the\ncustomer's balance until the order is confirmed (`reserved` → `cancelled`\nor `redeemed` via [Settle](/docs/{lang}/api-reference/loyalty/redeem/settle)).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"refId\": \"<refId>\",\n    \"reserve\": 0,\n    \"couponCode\": \"<couponCode>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"person\":       184532,\n    \"redeem\":       { \"reserved\": 1500 },\n    \"dateTime\":     \"2026-08-27T18:12:31-03:00\"\n}"
                                },
                                {
                                    "name": "Hash not found / expired",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/redeem/reserve/{{hash}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "redeem",
                                                "reserve",
                                                "{{hash}}"
                                            ]
                                        },
                                        "description": "Reserves the redeemable amount tied to a previously calculated reward\npromise (the `hash`/`confirmToken` returned by [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)).\nThe reservation enters `waitSettlement` and points are held against the\ncustomer's balance until the order is confirmed (`reserved` → `cancelled`\nor `redeemed` via [Settle](/docs/{lang}/api-reference/loyalty/redeem/settle)).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"refId\": \"<refId>\",\n    \"reserve\": 0,\n    \"couponCode\": \"<couponCode>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Redeem: Settle",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/redeem/settle/{{hash}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "redeem",
                                        "settle",
                                        "{{hash}}"
                                    ]
                                },
                                "description": "Settles a redeem reservation — converts a `reserved` hold into a final\n`redeemed` debit on the customer's balance. Called after the order is\nconfirmed by the payment/POS layer.\n\nThe `{hash}` is the transaction id, not a card id: one call settles every\ncard held by that reservation.\n\nNote the response shape: the status is the **key** inside `redeem`, not a\nvalue — `{\"redeem\": {\"rescued\": 1500}}`, where the number is the amount in\ncents."
                            },
                            "response": [
                                {
                                    "name": "Settlement accepted",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/redeem/settle/{{hash}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "redeem",
                                                "settle",
                                                "{{hash}}"
                                            ]
                                        },
                                        "description": "Settles a redeem reservation — converts a `reserved` hold into a final\n`redeemed` debit on the customer's balance. Called after the order is\nconfirmed by the payment/POS layer.\n\nThe `{hash}` is the transaction id, not a card id: one call settles every\ncard held by that reservation.\n\nNote the response shape: the status is the **key** inside `redeem`, not a\nvalue — `{\"redeem\": {\"rescued\": 1500}}`, where the number is the amount in\ncents."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"organization\": \"acme\",\n    \"person\":       184532,\n    \"redeem\":       { \"rescued\": 1500 },\n    \"dateTime\":     \"2026-08-27T18:13:25-03:00\"\n}"
                                },
                                {
                                    "name": "Hash not found",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/redeem/settle/{{hash}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "redeem",
                                                "settle",
                                                "{{hash}}"
                                            ]
                                        },
                                        "description": "Settles a redeem reservation — converts a `reserved` hold into a final\n`redeemed` debit on the customer's balance. Called after the order is\nconfirmed by the payment/POS layer.\n\nThe `{hash}` is the transaction id, not a card id: one call settles every\ncard held by that reservation.\n\nNote the response shape: the status is the **key** inside `redeem`, not a\nvalue — `{\"redeem\": {\"rescued\": 1500}}`, where the number is the amount in\ncents."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Reports",
                    "item": [
                        {
                            "name": "Audience Targeted by Period",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/audience/{{start}}/{{end}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "audience",
                                        "{{start}}",
                                        "{{end}}"
                                    ]
                                },
                                "description": "Who the campaigns were **addressed to** in a date window — the denominator\nbehind \"of the people we aimed at, how many actually got the reward\".\n\n*Cards* tells you how many rewards were created. It does not tell you how many\npeople the campaign tried to reach to get there. This endpoint is the other\nhalf: divide one by the other and you get the answer.\n\nThe work it does for you is that **the audience lives in three different\ntables, one per trigger, with three different units**. Everything comes back\nin **people**:\n\n| Trigger | Source | One row is |\n|---|---|---|\n| `audience-list` | the campaign audience | one person |\n| `reactivate-reward` | the reactivation queue | one customer |\n| `last-chance` | the last-chance queue | one **card × campaign** |\n\nLast chance is the trap: its queue is keyed by the expiring card, not by the\nperson, so one customer with three expiring cards produces three rows.\nCounting rows there inflates the audience by more than double and halves any\nrate built on it. This endpoint deduplicates it for you.\n\nTwo numbers come back, and only one of them is a denominator:\n\n- **`targeted`** — distinct people **within each campaign**, summed. This is\n  what pairs with rewards granted, because a reward is also created per\n  (campaign, person): someone in two campaigns counts twice on **both** sides\n  of the division.\n- **`clients`** — distinct people across the trigger. It answers \"how many\n  people did we reach\", and must never be used as a denominator.\n\n**Triggers with no audience do not appear here, on purpose.**\n`form-submission` and `external-events` start from something the customer did\n— nobody was addressed. Adding their rewards to a denominator that does not\nexist drops the rate for no reason. `meta.triggers` lists what is covered.\n\nNote there is no `birthday` trigger. Birthday campaigns exist, but they are\nbuilt as an audience list, so they come back in that bucket."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/audience/{{start}}/{{end}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "audience",
                                                "{{start}}",
                                                "{{end}}"
                                            ]
                                        },
                                        "description": "Who the campaigns were **addressed to** in a date window — the denominator\nbehind \"of the people we aimed at, how many actually got the reward\".\n\n*Cards* tells you how many rewards were created. It does not tell you how many\npeople the campaign tried to reach to get there. This endpoint is the other\nhalf: divide one by the other and you get the answer.\n\nThe work it does for you is that **the audience lives in three different\ntables, one per trigger, with three different units**. Everything comes back\nin **people**:\n\n| Trigger | Source | One row is |\n|---|---|---|\n| `audience-list` | the campaign audience | one person |\n| `reactivate-reward` | the reactivation queue | one customer |\n| `last-chance` | the last-chance queue | one **card × campaign** |\n\nLast chance is the trap: its queue is keyed by the expiring card, not by the\nperson, so one customer with three expiring cards produces three rows.\nCounting rows there inflates the audience by more than double and halves any\nrate built on it. This endpoint deduplicates it for you.\n\nTwo numbers come back, and only one of them is a denominator:\n\n- **`targeted`** — distinct people **within each campaign**, summed. This is\n  what pairs with rewards granted, because a reward is also created per\n  (campaign, person): someone in two campaigns counts twice on **both** sides\n  of the division.\n- **`clients`** — distinct people across the trigger. It answers \"how many\n  people did we reach\", and must never be used as a denominator.\n\n**Triggers with no audience do not appear here, on purpose.**\n`form-submission` and `external-events` start from something the customer did\n— nobody was addressed. Adding their rewards to a denominator that does not\nexist drops the rate for no reason. `meta.triggers` lists what is covered.\n\nNote there is no `birthday` trigger. Birthday campaigns exist, but they are\nbuilt as an audience list, so they come back in that bucket."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "`start` is after `end`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/audience/{{start}}/{{end}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "audience",
                                                "{{start}}",
                                                "{{end}}"
                                            ]
                                        },
                                        "description": "Who the campaigns were **addressed to** in a date window — the denominator\nbehind \"of the people we aimed at, how many actually got the reward\".\n\n*Cards* tells you how many rewards were created. It does not tell you how many\npeople the campaign tried to reach to get there. This endpoint is the other\nhalf: divide one by the other and you get the answer.\n\nThe work it does for you is that **the audience lives in three different\ntables, one per trigger, with three different units**. Everything comes back\nin **people**:\n\n| Trigger | Source | One row is |\n|---|---|---|\n| `audience-list` | the campaign audience | one person |\n| `reactivate-reward` | the reactivation queue | one customer |\n| `last-chance` | the last-chance queue | one **card × campaign** |\n\nLast chance is the trap: its queue is keyed by the expiring card, not by the\nperson, so one customer with three expiring cards produces three rows.\nCounting rows there inflates the audience by more than double and halves any\nrate built on it. This endpoint deduplicates it for you.\n\nTwo numbers come back, and only one of them is a denominator:\n\n- **`targeted`** — distinct people **within each campaign**, summed. This is\n  what pairs with rewards granted, because a reward is also created per\n  (campaign, person): someone in two campaigns counts twice on **both** sides\n  of the division.\n- **`clients`** — distinct people across the trigger. It answers \"how many\n  people did we reach\", and must never be used as a denominator.\n\n**Triggers with no audience do not appear here, on purpose.**\n`form-submission` and `external-events` start from something the customer did\n— nobody was addressed. Adding their rewards to a denominator that does not\nexist drops the rate for no reason. `meta.triggers` lists what is covered.\n\nNote there is no `birthday` trigger. Birthday campaigns exist, but they are\nbuilt as an audience list, so they come back in that bucket."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Cashback issued & redeemed by campaign (aggregate)",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cards/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "cards",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Org-wide cashback aggregate — cards issued, credit distributed, redeemed,\nbalance and expired — broken down by month, day, campaign, campaign trigger or\nstore, in a **single call**. It is the campaign report, grouped: instead of\ncalling the per-campaign report once per campaign (an org can have hundreds),\nthis returns every campaign at once.\n\nThis is the **program dashboard / KPIs for cashback emission and redemption**:\nhow much was **issued, redeemed and expired per campaign** in the period. (For\nthe current spendable balance per wallet — available, used — use the reward\nbalances report instead; this one is the emission/redemption flow over time.)\n\nReconciles with `loyalty.campaign.report` by construction — same source, same\nmath: `rewardCard` for issuance/balance/cards, `rewardCard_flow` for the\nprecise redeemed value.\n\n**Conversion (usage of the cards).** A card counts as used when a sale that\nspent its balance was **settled** — partial or full use both count. Open\ncheckout reservations and canceled reservations do not. Card balance is never\nused for this: it also drops on reward reversals and manual debits.\n\n- `touchedCards` — cards issued in the period (not canceled) with any settled\n  redemption, at any date. `touchedRedeemed` — the value those same cards\n  redeemed, at any date (`redeemed` follows the redemption date instead).\n- `cardsRedeemedFull` / `cardsRedeemedPartial` — of those, the ones that spent\n  the whole credit / that still had balance left.\n- `usageRate` — **conversion rate**: `touchedCards / (cards − cardsCanceled)`,\n  in %. `partialShare` / `fullShare` — % of `touchedCards` (they add up to 100).\n- Status buckets that add up to `cards`: `cardsRedeemed` (card with **zero**\n  balance), `cardsExpired`, `cardsCanceled`, `cardsActive`. `cardsRedeemed` is\n  not the conversion: a reversal also zeroes a card.\n- `expiredBalance` — balance left on the expired cards: the credit lost\n  because it was not used in time (same cut as `cardsExpired`).\n\nA recent period is still maturing — its conversion keeps rising while the\ncards are valid. Compare with an older, closed period.\n\nValues are in **cents**. Reward type is separated (`rewardType=monetary` by\ndefault) — point wallets are a different scale and must not be summed with\ncash. Test cards (`production=0`) are excluded. Canceled cards are counted\napart (`cardsCanceled`), never dropped silently. The day is cut in the\norganization timezone, so it lines up with the sales report by (month, store).\n\n`redeemed` is the settled redeemed value. With `cohort=redemption` (default)\nit is windowed by the **redemption date** — a card issued in July and redeemed\nin August shows its issuance in July and its redeemed value in August. With\n`cohort=issuance` it is the value redeemed, at any date, from the cards\n**issued** in the period (\"what happened to what I issued\").\n\n`groupBy=tier` breaks the numbers down by the member tier **at issuance** — a\nsnapshot taken on the card when it was created (the tier at purchase is\nimmutable). `tier=null` means the card had no tier (anonymous / unidentified, or\nissued before this snapshot shipped; history is not backfilled unless stated).\n\nStill not here: **channel** — group by `store` and join the store-group map\nclient-side."
                            },
                            "response": [
                                {
                                    "name": "OK — with `groupBy=campaign&campaign=191&cohort=issuance`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cards/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "cards",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Org-wide cashback aggregate — cards issued, credit distributed, redeemed,\nbalance and expired — broken down by month, day, campaign, campaign trigger or\nstore, in a **single call**. It is the campaign report, grouped: instead of\ncalling the per-campaign report once per campaign (an org can have hundreds),\nthis returns every campaign at once.\n\nThis is the **program dashboard / KPIs for cashback emission and redemption**:\nhow much was **issued, redeemed and expired per campaign** in the period. (For\nthe current spendable balance per wallet — available, used — use the reward\nbalances report instead; this one is the emission/redemption flow over time.)\n\nReconciles with `loyalty.campaign.report` by construction — same source, same\nmath: `rewardCard` for issuance/balance/cards, `rewardCard_flow` for the\nprecise redeemed value.\n\n**Conversion (usage of the cards).** A card counts as used when a sale that\nspent its balance was **settled** — partial or full use both count. Open\ncheckout reservations and canceled reservations do not. Card balance is never\nused for this: it also drops on reward reversals and manual debits.\n\n- `touchedCards` — cards issued in the period (not canceled) with any settled\n  redemption, at any date. `touchedRedeemed` — the value those same cards\n  redeemed, at any date (`redeemed` follows the redemption date instead).\n- `cardsRedeemedFull` / `cardsRedeemedPartial` — of those, the ones that spent\n  the whole credit / that still had balance left.\n- `usageRate` — **conversion rate**: `touchedCards / (cards − cardsCanceled)`,\n  in %. `partialShare` / `fullShare` — % of `touchedCards` (they add up to 100).\n- Status buckets that add up to `cards`: `cardsRedeemed` (card with **zero**\n  balance), `cardsExpired`, `cardsCanceled`, `cardsActive`. `cardsRedeemed` is\n  not the conversion: a reversal also zeroes a card.\n- `expiredBalance` — balance left on the expired cards: the credit lost\n  because it was not used in time (same cut as `cardsExpired`).\n\nA recent period is still maturing — its conversion keeps rising while the\ncards are valid. Compare with an older, closed period.\n\nValues are in **cents**. Reward type is separated (`rewardType=monetary` by\ndefault) — point wallets are a different scale and must not be summed with\ncash. Test cards (`production=0`) are excluded. Canceled cards are counted\napart (`cardsCanceled`), never dropped silently. The day is cut in the\norganization timezone, so it lines up with the sales report by (month, store).\n\n`redeemed` is the settled redeemed value. With `cohort=redemption` (default)\nit is windowed by the **redemption date** — a card issued in July and redeemed\nin August shows its issuance in July and its redeemed value in August. With\n`cohort=issuance` it is the value redeemed, at any date, from the cards\n**issued** in the period (\"what happened to what I issued\").\n\n`groupBy=tier` breaks the numbers down by the member tier **at issuance** — a\nsnapshot taken on the card when it was created (the tier at purchase is\nimmutable). `tier=null` means the card had no tier (anonymous / unidentified, or\nissued before this snapshot shipped; history is not backfilled unless stated).\n\nStill not here: **channel** — group by `store` and join the store-group map\nclient-side."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"cents\", \"timezone\": \"Etc/GMT+6\",\n    \"groupBy\": [\"campaign\"], \"rewardType\": \"monetary\",\n    \"cohort\": \"issuance\",\n    \"filters\": { \"campaign\": 191, \"store\": null }\n  },\n  \"rows\": [\n    { \"campaign\": 191, \"cards\": 6687, \"clients\": 5798, \"creditIssued\": 352339478,\n      \"redeemed\": 34095898, \"balance\": 0, \"expiredBalance\": 314870362, \"cardsRedeemed\": 280,\n      \"cardsExpired\": 6319, \"cardsCanceled\": 88, \"cardsActive\": 0,\n      \"touchedCards\": 696, \"touchedRedeemed\": 34095898, \"cardsRedeemedPartial\": 448, \"cardsRedeemedFull\": 248,\n      \"usageRate\": 10.5, \"partialShare\": 64.4, \"fullShare\": 35.6 }\n  ],\n  \"total\": {\n    \"clients\": 5798, \"cards\": 6687, \"creditIssued\": 352339478,\n    \"redeemed\": 34095898, \"balance\": 0, \"expiredBalance\": 314870362, \"cardsRedeemed\": 280,\n    \"cardsExpired\": 6319, \"cardsCanceled\": 88, \"cardsActive\": 0,\n    \"touchedCards\": 696, \"touchedRedeemed\": 34095898, \"cardsRedeemedPartial\": 448, \"cardsRedeemedFull\": 248,\n    \"usageRate\": 10.5, \"partialShare\": 64.4, \"fullShare\": 35.6\n  }\n}"
                                },
                                {
                                    "name": "Invalid `groupBy`, `rewardType` or `cohort`, `month` combined with `day`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cards/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "cards",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Org-wide cashback aggregate — cards issued, credit distributed, redeemed,\nbalance and expired — broken down by month, day, campaign, campaign trigger or\nstore, in a **single call**. It is the campaign report, grouped: instead of\ncalling the per-campaign report once per campaign (an org can have hundreds),\nthis returns every campaign at once.\n\nThis is the **program dashboard / KPIs for cashback emission and redemption**:\nhow much was **issued, redeemed and expired per campaign** in the period. (For\nthe current spendable balance per wallet — available, used — use the reward\nbalances report instead; this one is the emission/redemption flow over time.)\n\nReconciles with `loyalty.campaign.report` by construction — same source, same\nmath: `rewardCard` for issuance/balance/cards, `rewardCard_flow` for the\nprecise redeemed value.\n\n**Conversion (usage of the cards).** A card counts as used when a sale that\nspent its balance was **settled** — partial or full use both count. Open\ncheckout reservations and canceled reservations do not. Card balance is never\nused for this: it also drops on reward reversals and manual debits.\n\n- `touchedCards` — cards issued in the period (not canceled) with any settled\n  redemption, at any date. `touchedRedeemed` — the value those same cards\n  redeemed, at any date (`redeemed` follows the redemption date instead).\n- `cardsRedeemedFull` / `cardsRedeemedPartial` — of those, the ones that spent\n  the whole credit / that still had balance left.\n- `usageRate` — **conversion rate**: `touchedCards / (cards − cardsCanceled)`,\n  in %. `partialShare` / `fullShare` — % of `touchedCards` (they add up to 100).\n- Status buckets that add up to `cards`: `cardsRedeemed` (card with **zero**\n  balance), `cardsExpired`, `cardsCanceled`, `cardsActive`. `cardsRedeemed` is\n  not the conversion: a reversal also zeroes a card.\n- `expiredBalance` — balance left on the expired cards: the credit lost\n  because it was not used in time (same cut as `cardsExpired`).\n\nA recent period is still maturing — its conversion keeps rising while the\ncards are valid. Compare with an older, closed period.\n\nValues are in **cents**. Reward type is separated (`rewardType=monetary` by\ndefault) — point wallets are a different scale and must not be summed with\ncash. Test cards (`production=0`) are excluded. Canceled cards are counted\napart (`cardsCanceled`), never dropped silently. The day is cut in the\norganization timezone, so it lines up with the sales report by (month, store).\n\n`redeemed` is the settled redeemed value. With `cohort=redemption` (default)\nit is windowed by the **redemption date** — a card issued in July and redeemed\nin August shows its issuance in July and its redeemed value in August. With\n`cohort=issuance` it is the value redeemed, at any date, from the cards\n**issued** in the period (\"what happened to what I issued\").\n\n`groupBy=tier` breaks the numbers down by the member tier **at issuance** — a\nsnapshot taken on the card when it was created (the tier at purchase is\nimmutable). `tier=null` means the card had no tier (anonymous / unidentified, or\nissued before this snapshot shipped; history is not backfilled unless stated).\n\nStill not here: **channel** — group by `store` and join the store-group map\nclient-side."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "CashBack Card Expired",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cashBackCardExpired/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "cashBackCardExpired",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "**Request body parameters**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| interface \\* | string | interface of sale |\n| storeId \\* | string |  |\n| client | array / int / null | In this field, you can enter an `id`(person ID, guper), leave it as `null` to represent an anonymous customer, or fill it with a complete customer's data, as shown in the example: `{\"id\": \"47\", \"name\": \"Trifólio Girassol\", \"`countryCallingCode\": 55 `\"cellphone\": \"19954264546\", \"email\": \"`[<code>trifolio@girassol.com</code>](https://)`\"};`  <br>For already registered customers, it is necessary to provide at least `id` or `cellphone`. To register a new customer, you need to include `id`, `cellphone`, and `name`. Our API is responsible for handling customer registration and retrieval efficiently using this information. |\n| attendants | array |  |\n| items \\* | array |  |\n| total_order | int | total order amount |\n| total_item | int | total value of items only |\n| total_shipping | int | total amount of shipping fee only |\n| total_discounts | int | total amount of discounts; _Cashback values ​​should not be passed in this field_ |"
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cashBackCardExpired/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "cashBackCardExpired",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "**Request body parameters**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| interface \\* | string | interface of sale |\n| storeId \\* | string |  |\n| client | array / int / null | In this field, you can enter an `id`(person ID, guper), leave it as `null` to represent an anonymous customer, or fill it with a complete customer's data, as shown in the example: `{\"id\": \"47\", \"name\": \"Trifólio Girassol\", \"`countryCallingCode\": 55 `\"cellphone\": \"19954264546\", \"email\": \"`[<code>trifolio@girassol.com</code>](https://)`\"};`  <br>For already registered customers, it is necessary to provide at least `id` or `cellphone`. To register a new customer, you need to include `id`, `cellphone`, and `name`. Our API is responsible for handling customer registration and retrieval efficiently using this information. |\n| attendants | array |  |\n| items \\* | array |  |\n| total_order | int | total order amount |\n| total_item | int | total value of items only |\n| total_shipping | int | total amount of shipping fee only |\n| total_discounts | int | total amount of discounts; _Cashback values ​​should not be passed in this field_ |"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "CashBack Card Flow",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cashBackCardFlow/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "cashBackCardFlow",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "**Request body parameters**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| interface \\* | string | interface of sale |\n| storeId \\* | string |  |\n| client | array / int / null | In this field, you can enter an `id`(person ID, guper), leave it as `null` to represent an anonymous customer, or fill it with a complete customer's data, as shown in the example: `{\"id\": \"47\", \"name\": \"Trifólio Girassol\", \"`countryCallingCode\": 55 `\"cellphone\": \"19954264546\", \"email\": \"`[<code>trifolio@girassol.com</code>](https://)`\"};`  <br>For already registered customers, it is necessary to provide at least `id` or `cellphone`. To register a new customer, you need to include `id`, `cellphone`, and `name`. Our API is responsible for handling customer registration and retrieval efficiently using this information. |\n| attendants | array |  |\n| items \\* | array |  |\n| total_order | int | total order amount |\n| total_item | int | total value of items only |\n| total_shipping | int | total amount of shipping fee only |\n| total_discounts | int | total amount of discounts; _Cashback values ​​should not be passed in this field_ |"
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/cashBackCardFlow/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "cashBackCardFlow",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "**Request body parameters**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| interface \\* | string | interface of sale |\n| storeId \\* | string |  |\n| client | array / int / null | In this field, you can enter an `id`(person ID, guper), leave it as `null` to represent an anonymous customer, or fill it with a complete customer's data, as shown in the example: `{\"id\": \"47\", \"name\": \"Trifólio Girassol\", \"`countryCallingCode\": 55 `\"cellphone\": \"19954264546\", \"email\": \"`[<code>trifolio@girassol.com</code>](https://)`\"};`  <br>For already registered customers, it is necessary to provide at least `id` or `cellphone`. To register a new customer, you need to include `id`, `cellphone`, and `name`. Our API is responsible for handling customer registration and retrieval efficiently using this information. |\n| attendants | array |  |\n| items \\* | array |  |\n| total_order | int | total order amount |\n| total_item | int | total value of items only |\n| total_shipping | int | total amount of shipping fee only |\n| total_discounts | int | total amount of discounts; _Cashback values ​​should not be passed in this field_ |"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Notification campaign funnel: people reached, who bought, and the conversion",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/notifications/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "notifications",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "The funnel of the campaigns that **only send a message**: how many people the\nmessage reached, and how many of them bought. It is the **denominator** no other\nreport has — `order.report.sales` says how much the message generated, not at\nwhat cost of reach.\n\nOnly campaigns with `type = notification`. That is the attribution rule, not a\nconvenience: a monetary or point campaign issues a reward card and is attributed\nby the **redemption** of that balance; the message it sends is a cashback notice,\nnot \"the message that brought the customer\". Without this cut, on 2026-08-14 one\norganization had 24,035 message attributions coming from monetary campaigns\nagainst 41 from notification campaigns — 99.8% of them undue.\n\n⚠️ **Two different dates, and the response keeps them apart** instead of folding\nthem into a single rate:\n\n- **`total`** is the **cohort**: messages *sent* inside the window\n  (`notificationCard.createdAt`), and how many of those have already converted,\n  on any date. Conversion only means something this way — numerator and\n  denominator are the same people. A recent window is immature: most of it is\n  still `open`, and its conversion keeps rising afterwards.\n- **`total.result`** is what *happened* inside the window (`attributionDate`):\n  the attributions and orders of the period. This is the block that lines up with\n  the influenced revenue of `order.report.sales`, which also filters by the sale\n  date.\n\nThe attribution window of each message is\n`COALESCE(expiresAt, attributionAt, createdAt + 30 days)`. ⚠️ `attributionAt` is\n**not** the date a purchase was attributed — it is written at the card's birth and\nis deprecated; counting conversion by it would always give 100%. Conversion lives\nonly in the attribution table.\n\nThe three buckets `converted` / `open` / `expired` are exclusive and add up to\n`sent`, so the screen can show where every message stands."
                            },
                            "response": [
                                {
                                    "name": "OK — with `groupBy=campaign,day`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/notifications/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "notifications",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "The funnel of the campaigns that **only send a message**: how many people the\nmessage reached, and how many of them bought. It is the **denominator** no other\nreport has — `order.report.sales` says how much the message generated, not at\nwhat cost of reach.\n\nOnly campaigns with `type = notification`. That is the attribution rule, not a\nconvenience: a monetary or point campaign issues a reward card and is attributed\nby the **redemption** of that balance; the message it sends is a cashback notice,\nnot \"the message that brought the customer\". Without this cut, on 2026-08-14 one\norganization had 24,035 message attributions coming from monetary campaigns\nagainst 41 from notification campaigns — 99.8% of them undue.\n\n⚠️ **Two different dates, and the response keeps them apart** instead of folding\nthem into a single rate:\n\n- **`total`** is the **cohort**: messages *sent* inside the window\n  (`notificationCard.createdAt`), and how many of those have already converted,\n  on any date. Conversion only means something this way — numerator and\n  denominator are the same people. A recent window is immature: most of it is\n  still `open`, and its conversion keeps rising afterwards.\n- **`total.result`** is what *happened* inside the window (`attributionDate`):\n  the attributions and orders of the period. This is the block that lines up with\n  the influenced revenue of `order.report.sales`, which also filters by the sale\n  date.\n\nThe attribution window of each message is\n`COALESCE(expiresAt, attributionAt, createdAt + 30 days)`. ⚠️ `attributionAt` is\n**not** the date a purchase was attributed — it is written at the card's birth and\nis deprecated; counting conversion by it would always give 100%. Conversion lives\nonly in the attribution table.\n\nThe three buckets `converted` / `open` / `expired` are exclusive and add up to\n`sent`, so the screen can show where every message stands."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"clients\",\n    \"timezone\": \"America/Sao_Paulo\",\n    \"window\": { \"start\": \"2026-09-01\", \"end\": \"2026-09-22\" },\n    \"groupBy\": [\"campaign\", \"day\"]\n  },\n  \"total\": {\n    \"sent\": 23964, \"clients\": 23694,\n    \"converted\": 124, \"convertedClients\": 124,\n    \"open\": 22889, \"expired\": 951,\n    \"conversionRate\": 0.0052,\n    \"result\": { \"attributions\": 139, \"orders\": 139, \"clients\": 124 }\n  },\n  \"byCampaign\": [\n    {\n      \"campaign\": 664, \"campaignName\": \"09-moda-producto-correo-septiembre-2026\",\n      \"sent\": 3948, \"clients\": 3948,\n      \"converted\": 13, \"convertedClients\": 13,\n      \"open\": 3800, \"expired\": 135, \"conversionRate\": 0.0033,\n      \"result\": { \"attributions\": 14, \"orders\": 14, \"clients\": 13 }\n    }\n  ],\n  \"byDay\": [\n    { \"day\": \"2026-09-01\", \"sent\": 1204, \"clients\": 1204, \"attributions\": 6, \"orders\": 6 }\n  ]\n}"
                                },
                                {
                                    "name": "Invalid `groupBy`, a campaign id that is not a positive integer, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/notifications/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "notifications",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "The funnel of the campaigns that **only send a message**: how many people the\nmessage reached, and how many of them bought. It is the **denominator** no other\nreport has — `order.report.sales` says how much the message generated, not at\nwhat cost of reach.\n\nOnly campaigns with `type = notification`. That is the attribution rule, not a\nconvenience: a monetary or point campaign issues a reward card and is attributed\nby the **redemption** of that balance; the message it sends is a cashback notice,\nnot \"the message that brought the customer\". Without this cut, on 2026-08-14 one\norganization had 24,035 message attributions coming from monetary campaigns\nagainst 41 from notification campaigns — 99.8% of them undue.\n\n⚠️ **Two different dates, and the response keeps them apart** instead of folding\nthem into a single rate:\n\n- **`total`** is the **cohort**: messages *sent* inside the window\n  (`notificationCard.createdAt`), and how many of those have already converted,\n  on any date. Conversion only means something this way — numerator and\n  denominator are the same people. A recent window is immature: most of it is\n  still `open`, and its conversion keeps rising afterwards.\n- **`total.result`** is what *happened* inside the window (`attributionDate`):\n  the attributions and orders of the period. This is the block that lines up with\n  the influenced revenue of `order.report.sales`, which also filters by the sale\n  date.\n\nThe attribution window of each message is\n`COALESCE(expiresAt, attributionAt, createdAt + 30 days)`. ⚠️ `attributionAt` is\n**not** the date a purchase was attributed — it is written at the card's birth and\nis deprecated; counting conversion by it would always give 100%. Conversion lives\nonly in the attribution table.\n\nThe three buckets `converted` / `open` / `expired` are exclusive and add up to\n`sent`, so the screen can show where every message stands."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Cashback time-to-redeem report: days or weeks until the balance is used (distribution, median, p90)",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemption-latency/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "redemption-latency",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Distribution of the **time until a cashback card is redeemed** — how many card\nuses happened on the first day, the second day, and so on (or per week). It is a\ndistribution, not an average: the average hides exactly what matters, which is\nthe concentration in the first days against the tail near expiry. `median` and\n`p90` come from the same distribution.\n\n`basis` says where the clock starts:\n\n- `available` (default): when the card became usable (`startsAt`, after the\n  campaign waiting period). Use it to tune the validity period.\n- `issued`: when the card was issued. Includes the waiting period.\n\nBuckets are **complete periods** (24 hours or 7 days) between the basis and the\ncheckout debit; bucket `0` is the first day/week. Only **settled** redemptions\ncount. The grain is the **card use**: a redemption that used two cards\ncontributes two latencies (`uses`); `redemptions` is the count of distinct\nredemptions in the bucket. `share` is `uses / total` (a ratio).\n\nSame filters as `loyalty.report.redemptions`: `cohort` (`redemption` = debits in\nthe period, default; `issuance` = cards issued in the period), `campaign` (list),\n`originStore`, `redeemStore`. Values in **cents**."
                            },
                            "response": [
                                {
                                    "name": "OK — `cohort=issuance` (excerpt)",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemption-latency/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "redemption-latency",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Distribution of the **time until a cashback card is redeemed** — how many card\nuses happened on the first day, the second day, and so on (or per week). It is a\ndistribution, not an average: the average hides exactly what matters, which is\nthe concentration in the first days against the tail near expiry. `median` and\n`p90` come from the same distribution.\n\n`basis` says where the clock starts:\n\n- `available` (default): when the card became usable (`startsAt`, after the\n  campaign waiting period). Use it to tune the validity period.\n- `issued`: when the card was issued. Includes the waiting period.\n\nBuckets are **complete periods** (24 hours or 7 days) between the basis and the\ncheckout debit; bucket `0` is the first day/week. Only **settled** redemptions\ncount. The grain is the **card use**: a redemption that used two cards\ncontributes two latencies (`uses`); `redemptions` is the count of distinct\nredemptions in the bucket. `share` is `uses / total` (a ratio).\n\nSame filters as `loyalty.report.redemptions`: `cohort` (`redemption` = debits in\nthe period, default; `issuance` = cards issued in the period), `campaign` (list),\n`originStore`, `redeemStore`. Values in **cents**."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": { \"unit\": \"days\", \"basis\": \"cardAvailableAt\", \"cohort\": \"issuance\", \"timezone\": \"Etc/GMT+6\" },\n  \"total\": 767,\n  \"median\": 2,\n  \"p90\": 8,\n  \"rows\": [\n    { \"bucket\": 0, \"uses\": 172, \"redemptions\": 166, \"redeemedValue\": 7788667, \"share\": 0.2243 },\n    { \"bucket\": 1, \"uses\": 121, \"redemptions\": 117, \"redeemedValue\": 4434159, \"share\": 0.1578 },\n    { \"bucket\": 2, \"uses\": 100, \"redemptions\": 100, \"redeemedValue\": 3856692, \"share\": 0.1304 }\n  ]\n}"
                                },
                                {
                                    "name": "Invalid `buckets`, `basis`, `cohort` or `rewardType`, a non-integer filter, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemption-latency/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "redemption-latency",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Distribution of the **time until a cashback card is redeemed** — how many card\nuses happened on the first day, the second day, and so on (or per week). It is a\ndistribution, not an average: the average hides exactly what matters, which is\nthe concentration in the first days against the tail near expiry. `median` and\n`p90` come from the same distribution.\n\n`basis` says where the clock starts:\n\n- `available` (default): when the card became usable (`startsAt`, after the\n  campaign waiting period). Use it to tune the validity period.\n- `issued`: when the card was issued. Includes the waiting period.\n\nBuckets are **complete periods** (24 hours or 7 days) between the basis and the\ncheckout debit; bucket `0` is the first day/week. Only **settled** redemptions\ncount. The grain is the **card use**: a redemption that used two cards\ncontributes two latencies (`uses`); `redemptions` is the count of distinct\nredemptions in the bucket. `share` is `uses / total` (a ratio).\n\nSame filters as `loyalty.report.redemptions`: `cohort` (`redemption` = debits in\nthe period, default; `issuance` = cards issued in the period), `campaign` (list),\n`originStore`, `redeemStore`. Values in **cents**."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Cashback redemptions report: which orders redeemed, per campaign, origin store vs redemption store (circulation)",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemptions/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "redemptions",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "**Settled** cashback redemptions — one row per (redemption, card) — with the\norder that used the balance, the store that **issued** the card and the store\nwhere it was **redeemed**. Paginated. Pass `groupBy` to get aggregates instead\n(by day, month, campaign, origin store and/or redemption store).\n\nUse it for the detail table of redemptions, to answer \"which orders used the\ncashback of campaign X\", and for **balance circulation between stores**\n(`groupBy=originStore,redeemStore`: where the balance was generated vs where it\nwas spent).\n\n**Grain: the card.** An order that used three cards shows up three times, so\nthere is **no order total** here on purpose — summing a ticket over these rows\ncounts the same order several times. For revenue per order use\n`order.report.sales` (with attribution) or `order.campaign.report`.\n\nA redemption counts only once the sale is **settled**. Open checkout\nreservations and canceled reservations are left out. `redeemedValue` is the\ndebit minus any partial reversal of that same redemption, on that card.\n\n`cohort=redemption` (default): debits (checkout) dated in the period, from\ncards of any date. `cohort=issuance`: cards issued in the period, redeemed at\nany date. Values are in **cents**; dates are in the organization timezone.\nTest cards (`production=0`) are excluded; `rewardType` defaults to `monetary`.\n\nIn aggregates, `redemptions` (distinct redemptions), `cards` (distinct cards)\nand `orders` (distinct orders) are different counts — none of them is a\ndenominator for the others."
                            },
                            "response": [
                                {
                                    "name": "OK — list (`campaign=191&cohort=issuance&entries=1`)",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemptions/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "redemptions",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "**Settled** cashback redemptions — one row per (redemption, card) — with the\norder that used the balance, the store that **issued** the card and the store\nwhere it was **redeemed**. Paginated. Pass `groupBy` to get aggregates instead\n(by day, month, campaign, origin store and/or redemption store).\n\nUse it for the detail table of redemptions, to answer \"which orders used the\ncashback of campaign X\", and for **balance circulation between stores**\n(`groupBy=originStore,redeemStore`: where the balance was generated vs where it\nwas spent).\n\n**Grain: the card.** An order that used three cards shows up three times, so\nthere is **no order total** here on purpose — summing a ticket over these rows\ncounts the same order several times. For revenue per order use\n`order.report.sales` (with attribution) or `order.campaign.report`.\n\nA redemption counts only once the sale is **settled**. Open checkout\nreservations and canceled reservations are left out. `redeemedValue` is the\ndebit minus any partial reversal of that same redemption, on that card.\n\n`cohort=redemption` (default): debits (checkout) dated in the period, from\ncards of any date. `cohort=issuance`: cards issued in the period, redeemed at\nany date. Values are in **cents**; dates are in the organization timezone.\nTest cards (`production=0`) are excluded; `rewardType` defaults to `monetary`.\n\nIn aggregates, `redemptions` (distinct redemptions), `cards` (distinct cards)\nand `orders` (distinct orders) are different counts — none of them is a\ndenominator for the others."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": { \"unit\": \"cents\", \"timezone\": \"Etc/GMT+6\", \"cohort\": \"issuance\", \"groupBy\": null },\n  \"total\": { \"rows\": 757, \"redemptions\": 694, \"orders\": 694, \"redeemedValue\": 34095898 },\n  \"page\": 1, \"entries\": 1, \"pages\": 757,\n  \"list\": [\n    { \"tid\": \"f19f97178e926abacd584819d8e83e954b5254c4c6b12aea23c02670d21eb9e3\",\n      \"cardId\": 334708, \"campaign\": 191, \"clientId\": 2461453,\n      \"originStore\": 1629, \"redeemStore\": 1629, \"orderId\": 3940209,\n      \"redeemedValue\": 147400, \"redeemedAt\": \"2025-10-04 15:26:23\",\n      \"settledAt\": \"2026-08-27 16:42:03\", \"cardCreatedAt\": \"2025-08-17 16:48:09\" }\n  ]\n}"
                                },
                                {
                                    "name": "OK — aggregate (`groupBy=campaign&campaign=191&cohort=issuance`)",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemptions/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "redemptions",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "**Settled** cashback redemptions — one row per (redemption, card) — with the\norder that used the balance, the store that **issued** the card and the store\nwhere it was **redeemed**. Paginated. Pass `groupBy` to get aggregates instead\n(by day, month, campaign, origin store and/or redemption store).\n\nUse it for the detail table of redemptions, to answer \"which orders used the\ncashback of campaign X\", and for **balance circulation between stores**\n(`groupBy=originStore,redeemStore`: where the balance was generated vs where it\nwas spent).\n\n**Grain: the card.** An order that used three cards shows up three times, so\nthere is **no order total** here on purpose — summing a ticket over these rows\ncounts the same order several times. For revenue per order use\n`order.report.sales` (with attribution) or `order.campaign.report`.\n\nA redemption counts only once the sale is **settled**. Open checkout\nreservations and canceled reservations are left out. `redeemedValue` is the\ndebit minus any partial reversal of that same redemption, on that card.\n\n`cohort=redemption` (default): debits (checkout) dated in the period, from\ncards of any date. `cohort=issuance`: cards issued in the period, redeemed at\nany date. Values are in **cents**; dates are in the organization timezone.\nTest cards (`production=0`) are excluded; `rewardType` defaults to `monetary`.\n\nIn aggregates, `redemptions` (distinct redemptions), `cards` (distinct cards)\nand `orders` (distinct orders) are different counts — none of them is a\ndenominator for the others."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": { \"unit\": \"cents\", \"cohort\": \"issuance\", \"groupBy\": [\"campaign\"] },\n  \"rows\": [\n    { \"campaign\": 191, \"redemptions\": 694, \"cards\": 700, \"orders\": 694, \"clients\": 618, \"redeemedValue\": 34095898 }\n  ],\n  \"total\": { \"campaign\": null, \"redemptions\": 694, \"cards\": 700, \"orders\": 694, \"clients\": 618, \"redeemedValue\": 34095898 }\n}"
                                },
                                {
                                    "name": "Invalid `groupBy`, `cohort` or `rewardType`, a non-integer filter, `day` combined with `month`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/redemptions/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "redemptions",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "**Settled** cashback redemptions — one row per (redemption, card) — with the\norder that used the balance, the store that **issued** the card and the store\nwhere it was **redeemed**. Paginated. Pass `groupBy` to get aggregates instead\n(by day, month, campaign, origin store and/or redemption store).\n\nUse it for the detail table of redemptions, to answer \"which orders used the\ncashback of campaign X\", and for **balance circulation between stores**\n(`groupBy=originStore,redeemStore`: where the balance was generated vs where it\nwas spent).\n\n**Grain: the card.** An order that used three cards shows up three times, so\nthere is **no order total** here on purpose — summing a ticket over these rows\ncounts the same order several times. For revenue per order use\n`order.report.sales` (with attribution) or `order.campaign.report`.\n\nA redemption counts only once the sale is **settled**. Open checkout\nreservations and canceled reservations are left out. `redeemedValue` is the\ndebit minus any partial reversal of that same redemption, on that card.\n\n`cohort=redemption` (default): debits (checkout) dated in the period, from\ncards of any date. `cohort=issuance`: cards issued in the period, redeemed at\nany date. Values are in **cents**; dates are in the organization timezone.\nTest cards (`production=0`) are excluded; `rewardType` defaults to `monetary`.\n\nIn aggregates, `redemptions` (distinct redemptions), `cards` (distinct cards)\nand `orders` (distinct orders) are different counts — none of them is a\ndenominator for the others."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Reward Balances",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/rewardBalances/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "rewardBalances",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Returns the **organization-wide loyalty balances** aggregated over a date window. Cards are filtered by their **creation date** (`createAt`) between `dateStart` and `dateEnd`.\n\nThis is a `GET` and takes **no request body**. Both dates are required path params (`YYYY-MM-DD`).\n\n> To read the **current balance of a single customer**, use [Reward Balances By Person](/api-reference/loyalty/report/reward-balances-by-person) instead — it sums all of the customer's cards with no date window.\n\n> Monetary wallets return values in **cents** (divide by 100 to get the amount in the org currency). Point wallets (`rewardType: point`) return the point quantity.\n\n**Response fields**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `total` | int | Everything credited on cards created in the window (sum of all credits) |\n| `available` | int | Balance still available to redeem (cards not expired and not canceled) |\n| `expired` | int | Balance that expired without being redeemed |\n| `canceled` | int | Balance on canceled cards |\n| `used` | int | Balance already redeemed |\n| `byWallet` | object | Same metrics broken down per wallet (policy), keyed by wallet id |\n| `byWallet[id].name` | string | Wallet name |\n| `byWallet[id].rewardType` | string | `monetary` or `point` |"
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/rewardBalances/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "rewardBalances",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Returns the **organization-wide loyalty balances** aggregated over a date window. Cards are filtered by their **creation date** (`createAt`) between `dateStart` and `dateEnd`.\n\nThis is a `GET` and takes **no request body**. Both dates are required path params (`YYYY-MM-DD`).\n\n> To read the **current balance of a single customer**, use [Reward Balances By Person](/api-reference/loyalty/report/reward-balances-by-person) instead — it sums all of the customer's cards with no date window.\n\n> Monetary wallets return values in **cents** (divide by 100 to get the amount in the org currency). Point wallets (`rewardType: point`) return the point quantity.\n\n**Response fields**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `total` | int | Everything credited on cards created in the window (sum of all credits) |\n| `available` | int | Balance still available to redeem (cards not expired and not canceled) |\n| `expired` | int | Balance that expired without being redeemed |\n| `canceled` | int | Balance on canceled cards |\n| `used` | int | Balance already redeemed |\n| `byWallet` | object | Same metrics broken down per wallet (policy), keyed by wallet id |\n| `byWallet[id].name` | string | Wallet name |\n| `byWallet[id].rewardType` | string | `monetary` or `point` |"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"total\": 1284500,\n    \"available\": 642100,\n    \"expired\": 310200,\n    \"canceled\": 12000,\n    \"used\": 320200,\n    \"byWallet\": {\n        \"12\": {\n            \"name\": \"Cashback\",\n            \"rewardType\": \"monetary\",\n            \"total\": 1284500,\n            \"available\": 642100,\n            \"expired\": 310200,\n            \"canceled\": 12000,\n            \"used\": 320200\n        }\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Reward Balances By Person",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/report/rewardBalances/person/{{person}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "report",
                                        "rewardBalances",
                                        "person",
                                        "{{person}}"
                                    ]
                                },
                                "description": "Returns the **consolidated loyalty balance of a single customer**, summing **all of the customer's cards** with **no date window**. This is the canonical endpoint to read a customer's current balance — use the **`available`** field as the amount ready to redeem.\n\nThis is a `GET` and takes **no request body**. The only input is the `person` (customer) id in the path.\n\n> Monetary wallets return values in **cents** (divide by 100 to get the amount in the org currency). Point wallets (`rewardType: point`) return the point quantity.\n\n**Response fields**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `total` | int | Everything ever credited to the customer (sum of all credits, historical) |\n| `available` | int | **Balance available to redeem right now** (cards not expired and not canceled) |\n| `expired` | int | Balance that expired without being redeemed |\n| `canceled` | int | Balance on canceled cards |\n| `used` | int | Balance already redeemed |\n| `byWallet` | object | Same metrics broken down per wallet (policy), keyed by wallet id |\n| `byWallet[id].name` | string | Wallet name |\n| `byWallet[id].rewardType` | string | `monetary` or `point` |"
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/report/rewardBalances/person/{{person}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "report",
                                                "rewardBalances",
                                                "person",
                                                "{{person}}"
                                            ]
                                        },
                                        "description": "Returns the **consolidated loyalty balance of a single customer**, summing **all of the customer's cards** with **no date window**. This is the canonical endpoint to read a customer's current balance — use the **`available`** field as the amount ready to redeem.\n\nThis is a `GET` and takes **no request body**. The only input is the `person` (customer) id in the path.\n\n> Monetary wallets return values in **cents** (divide by 100 to get the amount in the org currency). Point wallets (`rewardType: point`) return the point quantity.\n\n**Response fields**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `total` | int | Everything ever credited to the customer (sum of all credits, historical) |\n| `available` | int | **Balance available to redeem right now** (cards not expired and not canceled) |\n| `expired` | int | Balance that expired without being redeemed |\n| `canceled` | int | Balance on canceled cards |\n| `used` | int | Balance already redeemed |\n| `byWallet` | object | Same metrics broken down per wallet (policy), keyed by wallet id |\n| `byWallet[id].name` | string | Wallet name |\n| `byWallet[id].rewardType` | string | `monetary` or `point` |"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"total\": 306943,\n    \"available\": 111541,\n    \"expired\": 88938,\n    \"canceled\": 0,\n    \"used\": 106464,\n    \"byWallet\": {\n        \"12\": {\n            \"name\": \"Cashback\",\n            \"rewardType\": \"monetary\",\n            \"total\": 306943,\n            \"available\": 111541,\n            \"expired\": 88938,\n            \"canceled\": 0,\n            \"used\": 106464\n        }\n    }\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Reward",
                    "item": [
                        {
                            "name": "Direct",
                            "item": [
                                {
                                    "name": "Reward Direct: Consume",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/reward",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "reward"
                                            ]
                                        },
                                        "description": "Debits points from a customer's reward balance against an order\npayload. Computes the value as `total_item / pointsDivisor *\npointsDividend` against the resolved policy, then executes the\nredeem on the matching cards (FIFO by expiration).\n\nReturns the cards that were touched plus the actual debited value.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": 47,\n    \"value\": 96390\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Debited",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/reward",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "reward"
                                                    ]
                                                },
                                                "description": "Debits points from a customer's reward balance against an order\npayload. Computes the value as `total_item / pointsDivisor *\npointsDividend` against the resolved policy, then executes the\nredeem on the matching cards (FIFO by expiration).\n\nReturns the cards that were touched plus the actual debited value.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": 47,\n    \"value\": 96390\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "Missing fields",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/reward",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "reward"
                                                    ]
                                                },
                                                "description": "Debits points from a customer's reward balance against an order\npayload. Computes the value as `total_item / pointsDivisor *\npointsDividend` against the resolved policy, then executes the\nredeem on the matching cards (FIFO by expiration).\n\nReturns the cards that were touched plus the actual debited value.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": 47,\n    \"value\": 96390\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Reward Direct: Create",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/reward",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "reward"
                                            ]
                                        },
                                        "description": "Manually issues a reward card to a customer, bypassing the order/engine\nflow. Common use cases: support credits, marketing one-offs, manual\nreconciliation.\n\nLinked to a **policy** so the card inherits the policy's expiration\nrules and aggregation mode.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"policy\": 1,\n    \"client\": 47,\n    \"value\": 5000,\n    \"expiresAt\": \"2026-12-31\",\n    \"startsAt\": \"2026-05-04\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Card created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/reward",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "reward"
                                                    ]
                                                },
                                                "description": "Manually issues a reward card to a customer, bypassing the order/engine\nflow. Common use cases: support credits, marketing one-offs, manual\nreconciliation.\n\nLinked to a **policy** so the card inherits the policy's expiration\nrules and aggregation mode.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"policy\": 1,\n    \"client\": 47,\n    \"value\": 5000,\n    \"expiresAt\": \"2026-12-31\",\n    \"startsAt\": \"2026-05-04\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"cardId\": 9182, \"policy\": 1, \"client\": 47, \"value\": 5000, \"expiresAt\": \"2026-12-31T23:59:59-03:00\" }"
                                        },
                                        {
                                            "name": "Missing/invalid fields or unknown policy",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/reward",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "loyalty",
                                                        "reward"
                                                    ]
                                                },
                                                "description": "Manually issues a reward card to a customer, bypassing the order/engine\nflow. Common use cases: support credits, marketing one-offs, manual\nreconciliation.\n\nLinked to a **policy** so the card inherits the policy's expiration\nrules and aggregation mode.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"policy\": 1,\n    \"client\": 47,\n    \"value\": 5000,\n    \"expiresAt\": \"2026-12-31\",\n    \"startsAt\": \"2026-05-04\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Reward: Find by hash",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/reward/{{hash}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "reward",
                                        "{{hash}}"
                                    ]
                                },
                                "description": "Returns the reward promise associated with a given `hash`/`confirmToken`\n— the response that was originally produced by [Search](/docs/{lang}/api-reference/loyalty/reward/search)\nor [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).\n\nUseful for resyncing the integration's local state when the cached\nresponse has been lost or expired."
                            },
                            "response": [
                                {
                                    "name": "Stored response payload",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/reward/{{hash}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "reward",
                                                "{{hash}}"
                                            ]
                                        },
                                        "description": "Returns the reward promise associated with a given `hash`/`confirmToken`\n— the response that was originally produced by [Search](/docs/{lang}/api-reference/loyalty/reward/search)\nor [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).\n\nUseful for resyncing the integration's local state when the cached\nresponse has been lost or expired."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Hash not found / expired",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/reward/{{hash}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "reward",
                                                "{{hash}}"
                                            ]
                                        },
                                        "description": "Returns the reward promise associated with a given `hash`/`confirmToken`\n— the response that was originally produced by [Search](/docs/{lang}/api-reference/loyalty/reward/search)\nor [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).\n\nUseful for resyncing the integration's local state when the cached\nresponse has been lost or expired."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Reward: Search",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/reward/search",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "reward",
                                        "search"
                                    ]
                                },
                                "description": "Calculates the reward (cashback / promotion / points) an order would\nreceive — same engine as [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nbut exposed as a standalone search endpoint. Returns a `hash`/`confirmToken`\nyou can later send to redeem/settle.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": {\n        \"id\": 47,\n        \"refId\": \"3143c4fb\",\n        \"name\": \"Trifólio Girassol\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"trifolio@girassol.com\",\n        \"document\": \"<document>\"\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000,\n            \"categoryId\": \"<categoryId>\",\n            \"brandId\": \"<brandId>\",\n            \"tax\": 0\n        }\n    ],\n    \"total_order\": 97390,\n    \"total_item\": 96390,\n    \"total_shipping\": 2000,\n    \"total_discounts\": 1000\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Reward computed (with hash)",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/reward/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "reward",
                                                "search"
                                            ]
                                        },
                                        "description": "Calculates the reward (cashback / promotion / points) an order would\nreceive — same engine as [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nbut exposed as a standalone search endpoint. Returns a `hash`/`confirmToken`\nyou can later send to redeem/settle.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": {\n        \"id\": 47,\n        \"refId\": \"3143c4fb\",\n        \"name\": \"Trifólio Girassol\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"trifolio@girassol.com\",\n        \"document\": \"<document>\"\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000,\n            \"categoryId\": \"<categoryId>\",\n            \"brandId\": \"<brandId>\",\n            \"tax\": 0\n        }\n    ],\n    \"total_order\": 97390,\n    \"total_item\": 96390,\n    \"total_shipping\": 2000,\n    \"total_discounts\": 1000\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Interface not defined",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/reward/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "reward",
                                                "search"
                                            ]
                                        },
                                        "description": "Calculates the reward (cashback / promotion / points) an order would\nreceive — same engine as [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nbut exposed as a standalone search endpoint. Returns a `hash`/`confirmToken`\nyou can later send to redeem/settle.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"generic\",\n    \"storeId\": \"1\",\n    \"client\": {\n        \"id\": 47,\n        \"refId\": \"3143c4fb\",\n        \"name\": \"Trifólio Girassol\",\n        \"countryCallingCode\": 55,\n        \"cellphone\": \"19954264546\",\n        \"email\": \"trifolio@girassol.com\",\n        \"document\": \"<document>\"\n    },\n    \"items\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Smartphone Guper MK1\",\n            \"quantity\": 1,\n            \"price\": 96390,\n            \"listPrice\": 100000,\n            \"categoryId\": \"<categoryId>\",\n            \"brandId\": \"<brandId>\",\n            \"tax\": 0\n        }\n    ],\n    \"total_order\": 97390,\n    \"total_item\": 96390,\n    \"total_shipping\": 2000,\n    \"total_discounts\": 1000\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Rules",
                    "item": [
                        {
                            "name": "List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/rule",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "rule"
                                    ]
                                },
                                "description": "Returns the paginated list of loyalty rules."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/rule",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "rule"
                                            ]
                                        },
                                        "description": "Returns the paginated list of loyalty rules."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 1,\n            \"name\": \"Compra de valor\",\n            \"class\": \"Rule\",\n            \"method\": \"value\",\n            \"priority\": 100\n        },\n        {\n            \"id\": 2,\n            \"name\": \"Produto da categoria\",\n            \"class\": \"Rule\",\n            \"method\": \"categoryItems\",\n            \"priority\": 0\n        },\n        {\n            \"id\": 3,\n            \"name\": \"Quantidade\",\n            \"class\": \"Rule\",\n            \"method\": \"quantityItems\",\n            \"priority\": 100\n        },\n        {\n            \"id\": 4,\n            \"name\": \"Produto da marca\",\n            \"class\": \"Rule\",\n            \"method\": \"brandProduct\",\n            \"priority\": 0\n        }\n    ],\n    \"total\": 4,\n    \"pagination\": {\n        \"entries\": 20,\n        \"totalPages\": 1,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": true,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 0\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/rule/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "rule",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single the rule matching the given identifier."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/rule/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "rule",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single the rule matching the given identifier."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 1,\n    \"name\": \"Compra de valor\",\n    \"class\": \"Rule\",\n    \"method\": \"value\",\n    \"priority\": 100\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Transaction",
                    "item": [
                        {
                            "name": "By Order — By Order ID",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/byOrder/{{idOrder}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "transaction",
                                        "byOrder",
                                        "{{idOrder}}"
                                    ]
                                },
                                "description": "Looks up transactions directly by Guper's internal `orderId`."
                            },
                            "response": [
                                {
                                    "name": "List of transactions tied to the order",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/byOrder/{{idOrder}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "transaction",
                                                "byOrder",
                                                "{{idOrder}}"
                                            ]
                                        },
                                        "description": "Looks up transactions directly by Guper's internal `orderId`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"order\": 2467383,\n    \"transactions\": [\n        {\n            \"TID\":        \"dcf33b4448d604033d12ce176253ee54851531212b29bde1468d359e82005b92\",\n            \"person\":     570971,\n            \"canceledAt\": null,\n            \"createdAt\":  \"2026-01-15T16:21:44-03:00\"\n        },\n        {\n            \"TID\":        \"8c91a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1\",\n            \"person\":     570971,\n            \"canceledAt\": \"2026-01-20T09:14:00-03:00\",\n            \"createdAt\":  \"2026-01-15T17:02:11-03:00\"\n        }\n    ]\n}"
                                },
                                {
                                    "name": "Missing order parameter",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/byOrder/{{idOrder}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "transaction",
                                                "byOrder",
                                                "{{idOrder}}"
                                            ]
                                        },
                                        "description": "Looks up transactions directly by Guper's internal `orderId`."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "No transaction found for this order",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/byOrder/{{idOrder}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "transaction",
                                                "byOrder",
                                                "{{idOrder}}"
                                            ]
                                        },
                                        "description": "Looks up transactions directly by Guper's internal `orderId`."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "By Order — By RefId",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/{{interface}}/transaction/byOrder/{{idOrRefId}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "{{interface}}",
                                        "transaction",
                                        "byOrder",
                                        "{{idOrRefId}}"
                                    ]
                                },
                                "description": "Accepts an external reference id. The order service resolves\n`interface` + `refId` to the internal `orderId` before the\nlookup. The response echoes the resolved `refId` and `interface`."
                            },
                            "response": [
                                {
                                    "name": "List of transactions tied to the order",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/{{interface}}/transaction/byOrder/{{idOrRefId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "{{interface}}",
                                                "transaction",
                                                "byOrder",
                                                "{{idOrRefId}}"
                                            ]
                                        },
                                        "description": "Accepts an external reference id. The order service resolves\n`interface` + `refId` to the internal `orderId` before the\nlookup. The response echoes the resolved `refId` and `interface`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"order\":     2467383,\n    \"refId\":     \"GUP-847\",\n    \"interface\": \"vtex\",\n    \"transactions\": [\n        {\n            \"TID\":        \"a411612a868befe17a8fde6076e25d8e0ea4c651dcaa88a24f97417627ad6d07\",\n            \"person\":     570971,\n            \"canceledAt\": null,\n            \"createdAt\":  \"2026-01-15T16:21:44-03:00\"\n        }\n    ]\n}"
                                },
                                {
                                    "name": "Missing order parameter",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/{{interface}}/transaction/byOrder/{{idOrRefId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "{{interface}}",
                                                "transaction",
                                                "byOrder",
                                                "{{idOrRefId}}"
                                            ]
                                        },
                                        "description": "Accepts an external reference id. The order service resolves\n`interface` + `refId` to the internal `orderId` before the\nlookup. The response echoes the resolved `refId` and `interface`."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Order or transaction not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/{{interface}}/transaction/byOrder/{{idOrRefId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "{{interface}}",
                                                "transaction",
                                                "byOrder",
                                                "{{idOrRefId}}"
                                            ]
                                        },
                                        "description": "Accepts an external reference id. The order service resolves\n`interface` + `refId` to the internal `orderId` before the\nlookup. The response echoes the resolved `refId` and `interface`."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Cancel",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/cancel/{{TID}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "transaction",
                                        "cancel",
                                        "{{TID}}"
                                    ]
                                },
                                "description": "Cancels the the transaction."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/cancel/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "transaction",
                                                "cancel",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Cancels the the transaction."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"TID\": \"5876f434afea2e0aafeed9bcc0adfd625b52e301fb9c1b5f437f2b819fa541e4\",\n    \"order\": 1898583,\n    \"reward\": [\n        {\n            \"cardId\": 95980,\n            \"value\": 5\n        }\n    ],\n    \"redemption\": [\n        {\n            \"cardId\": 74744,\n            \"value\": 50\n        }\n    ]\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/{{TID}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "loyalty",
                                        "transaction",
                                        "{{TID}}"
                                    ]
                                },
                                "description": "Returns a single the transaction matching the given identifier."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper. Omit only on endpoints that explicitly support a Public mode."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/loyalty/transaction/{{TID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "loyalty",
                                                "transaction",
                                                "{{TID}}"
                                            ]
                                        },
                                        "description": "Returns a single the transaction matching the given identifier."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"TID\": \"dcf33b4448d604033d12ce176253ee54851531212b29bde1468d359e82005b92\",\n    \"order\": 2467383,\n    \"reward\": [\n        {\n            \"cardId\": 185840,\n            \"value\": 0\n        }\n    ],\n    \"redemption\": [\n        {\n            \"cardId\": 185839,\n            \"value\": 1099\n        }\n    ]\n}"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Media Manager",
            "item": [
                {
                    "name": "Explorer",
                    "item": [
                        {
                            "name": "Get breadcrumb path",
                            "request": {
                                "method": "GET",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/{{id}}/breadcrumb",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "{{id}}",
                                        "breadcrumb"
                                    ]
                                },
                                "description": "Returns the hierarchical path from the root to the specified item, ordered\nfrom root to the item itself.\n\nUses a recursive CTE to walk up the parent chain from the given item to the\nroot, then returns the result in root-first order.\n\nUseful for rendering breadcrumb navigation in the UI.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "Array of ancestors from root to the item, in order.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}/breadcrumb",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}",
                                                "breadcrumb"
                                            ]
                                        },
                                        "description": "Returns the hierarchical path from the root to the specified item, ordered\nfrom root to the item itself.\n\nUses a recursive CTE to walk up the parent chain from the given item to the\nroot, then returns the result in root-first order.\n\nUseful for rendering breadcrumb navigation in the UI.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "[\n    { \"id\": 1, \"name\": \"banners\", \"contentType\": null },\n    { \"id\": 42, \"name\": \"summer\", \"contentType\": null },\n    { \"id\": 55, \"name\": \"hero-banner.jpg\", \"contentType\": \"image/jpeg\" }\n]"
                                },
                                {
                                    "name": "Item not found.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}/breadcrumb",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}",
                                                "breadcrumb"
                                            ]
                                        },
                                        "description": "Returns the hierarchical path from the root to the specified item, ordered\nfrom root to the item itself.\n\nUses a recursive CTE to walk up the parent chain from the given item to the\nroot, then returns the result in root-first order.\n\nUseful for rendering breadcrumb navigation in the UI.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Not found\" }"
                                }
                            ]
                        },
                        {
                            "name": "Confirm upload",
                            "request": {
                                "method": "POST",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/confirm/{{id}}",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "confirm",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Confirms that a file has been successfully uploaded to S3 and activates it.\n\nThis is step 3 of the **3-step upload flow** (see *upload-url*).\n\nThe endpoint verifies the file exists on S3 at the expected key. If a\n`contentHash` was provided during the upload-url step, it also validates the\nhash matches the uploaded file.\n\nOn success, the file `status` transitions from `pending` to `active` and the\nfile becomes visible in listings.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "Confirmed file with active status and size.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/confirm/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "confirm",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Confirms that a file has been successfully uploaded to S3 and activates it.\n\nThis is step 3 of the **3-step upload flow** (see *upload-url*).\n\nThe endpoint verifies the file exists on S3 at the expected key. If a\n`contentHash` was provided during the upload-url step, it also validates the\nhash matches the uploaded file.\n\nOn success, the file `status` transitions from `pending` to `active` and the\nfile becomes visible in listings.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 101,\n    \"name\": \"hero-banner.jpg\",\n    \"contentType\": \"image/jpeg\",\n    \"url\": \"https://cdn.example.com/org/101-hero-banner.jpg\",\n    \"size\": 245760,\n    \"status\": \"active\"\n}"
                                },
                                {
                                    "name": "File not found on S3 or invalid ID.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/confirm/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "confirm",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Confirms that a file has been successfully uploaded to S3 and activates it.\n\nThis is step 3 of the **3-step upload flow** (see *upload-url*).\n\nThe endpoint verifies the file exists on S3 at the expected key. If a\n`contentHash` was provided during the upload-url step, it also validates the\nhash matches the uploaded file.\n\nOn success, the file `status` transitions from `pending` to `active` and the\nfile becomes visible in listings.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"File not found on S3\" }"
                                },
                                {
                                    "name": "Content hash mismatch.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/confirm/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "confirm",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Confirms that a file has been successfully uploaded to S3 and activates it.\n\nThis is step 3 of the **3-step upload flow** (see *upload-url*).\n\nThe endpoint verifies the file exists on S3 at the expected key. If a\n`contentHash` was provided during the upload-url step, it also validates the\nhash matches the uploaded file.\n\nOn success, the file `status` transitions from `pending` to `active` and the\nfile becomes visible in listings.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Content hash does not match\" }"
                                }
                            ]
                        },
                        {
                            "name": "Create folder",
                            "request": {
                                "method": "POST",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/folder",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "folder"
                                    ]
                                },
                                "description": "Creates a new folder in the media manager explorer.\n\nFolders are items with `contentType: null`. They can be nested inside other\nfolders by providing a `parentId`.\n\nThe materialized `path` is automatically computed from the parent hierarchy\n(e.g. `/banners/summer/`).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "The created folder object.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/folder",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "folder"
                                            ]
                                        },
                                        "description": "Creates a new folder in the media manager explorer.\n\nFolders are items with `contentType: null`. They can be nested inside other\nfolders by providing a `parentId`.\n\nThe materialized `path` is automatically computed from the parent hierarchy\n(e.g. `/banners/summer/`).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 55,\n    \"name\": \"summer-campaign\",\n    \"contentType\": null,\n    \"path\": \"/banners/summer-campaign/\",\n    \"status\": \"active\",\n    \"parentId\": 42,\n    \"createdAt\": \"2026-06-23 14:30:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "List files and folders",
                            "request": {
                                "method": "GET",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer"
                                    ]
                                },
                                "description": "Returns a paginated list of files and folders in the media manager explorer.\n\nWhen `parentId` is provided, lists the contents of that folder. When omitted,\nlists the root level items.\n\nWhen `search` is provided, performs a global name search across all folders —\n`parentId` is ignored in search mode.\n\nOnly items with `status=active` are returned (trashed/deleted items are excluded).\n\nItems with `contentType: null` are **folders**; all other values indicate files.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "Paginated list of files and folders.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer"
                                            ]
                                        },
                                        "description": "Returns a paginated list of files and folders in the media manager explorer.\n\nWhen `parentId` is provided, lists the contents of that folder. When omitted,\nlists the root level items.\n\nWhen `search` is provided, performs a global name search across all folders —\n`parentId` is ignored in search mode.\n\nOnly items with `status=active` are returned (trashed/deleted items are excluded).\n\nItems with `contentType: null` are **folders**; all other values indicate files.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 1,\n            \"name\": \"banners\",\n            \"contentType\": null,\n            \"path\": \"/banners/\",\n            \"status\": \"active\",\n            \"url\": null\n        },\n        {\n            \"id\": 15,\n            \"name\": \"hero-banner.jpg\",\n            \"contentType\": \"image/jpeg\",\n            \"path\": \"/banners/hero-banner.jpg\",\n            \"status\": \"active\",\n            \"url\": \"https://cdn.example.com/org/hero-banner.jpg\"\n        }\n    ],\n    \"pagination\": {\n        \"entries\": 20,\n        \"totalPages\": 3,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": false\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Permanently delete file or folder",
                            "request": {
                                "method": "DELETE",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/{{id}}/permanent",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "{{id}}",
                                        "permanent"
                                    ]
                                },
                                "description": "Permanently deletes a file or folder. Removes the file from S3 and marks the\ndatabase record with `status=deleted`.\n\n**CASCADE:** if the target is a folder, all descendant files are deleted from\nS3 and all descendant records are marked as deleted.\n\nThis action is **irreversible** — the file data is removed from storage.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "Confirmation of the permanent deletion.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}/permanent",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}",
                                                "permanent"
                                            ]
                                        },
                                        "description": "Permanently deletes a file or folder. Removes the file from S3 and marks the\ndatabase record with `status=deleted`.\n\n**CASCADE:** if the target is a folder, all descendant files are deleted from\nS3 and all descendant records are marked as deleted.\n\nThis action is **irreversible** — the file data is removed from storage.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"success\": true,\n    \"id\": 101,\n    \"status\": \"deleted\"\n}"
                                },
                                {
                                    "name": "Item not found.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}/permanent",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}",
                                                "permanent"
                                            ]
                                        },
                                        "description": "Permanently deletes a file or folder. Removes the file from S3 and marks the\ndatabase record with `status=deleted`.\n\n**CASCADE:** if the target is a folder, all descendant files are deleted from\nS3 and all descendant records are marked as deleted.\n\nThis action is **irreversible** — the file data is removed from storage.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Not found\" }"
                                }
                            ]
                        },
                        {
                            "name": "Trash file or folder",
                            "request": {
                                "method": "DELETE",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/{{id}}",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Soft-deletes a file or folder by setting its status to `trashed`.\n\nTrashed items are excluded from normal listings but can be recovered.\n\n**CASCADE:** if the target is a folder, all descendant files and folders are\nalso trashed via the materialized path (all items whose `path` starts with the\nfolder's path are affected).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "Confirmation of the trash operation.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Soft-deletes a file or folder by setting its status to `trashed`.\n\nTrashed items are excluded from normal listings but can be recovered.\n\n**CASCADE:** if the target is a folder, all descendant files and folders are\nalso trashed via the materialized path (all items whose `path` starts with the\nfolder's path are affected).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"success\": true,\n    \"id\": 101\n}"
                                },
                                {
                                    "name": "Item not found.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Soft-deletes a file or folder by setting its status to `trashed`.\n\nTrashed items are excluded from normal listings but can be recovered.\n\n**CASCADE:** if the target is a folder, all descendant files and folders are\nalso trashed via the materialized path (all items whose `path` starts with the\nfolder's path are affected).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Not found\" }"
                                }
                            ]
                        },
                        {
                            "name": "Update file or folder",
                            "request": {
                                "method": "PUT",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/{{id}}",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Updates the metadata of a file or folder.\n\nCan be used to **rename** (change `name`), **move** (change `parentId`), or\nupdate the `description` of an item.\n\nWhen `parentId` is changed, the materialized `path` is recomputed for the item\nand all its descendants (if it is a folder).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "The updated file or folder object.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates the metadata of a file or folder.\n\nCan be used to **rename** (change `name`), **move** (change `parentId`), or\nupdate the `description` of an item.\n\nWhen `parentId` is changed, the materialized `path` is recomputed for the item\nand all its descendants (if it is a folder).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 101,\n    \"name\": \"new-name.jpg\",\n    \"contentType\": \"image/jpeg\",\n    \"path\": \"/banners/new-name.jpg\",\n    \"status\": \"active\",\n    \"parentId\": 42,\n    \"description\": \"Summer 2026 hero banner\",\n    \"url\": \"https://cdn.example.com/org/101-hero-banner.jpg\"\n}"
                                },
                                {
                                    "name": "Item not found.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/{{id}}",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates the metadata of a file or folder.\n\nCan be used to **rename** (change `name`), **move** (change `parentId`), or\nupdate the `description` of an item.\n\nWhen `parentId` is changed, the materialized `path` is recomputed for the item\nand all its descendants (if it is a folder).\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Not found\" }"
                                }
                            ]
                        },
                        {
                            "name": "Get upload URL",
                            "request": {
                                "method": "POST",
                                "header": [],
                                "url": {
                                    "raw": "/api/media-manager/explorer/upload-url",
                                    "path": [
                                        "api",
                                        "media-manager",
                                        "explorer",
                                        "upload-url"
                                    ]
                                },
                                "description": "Generates a pre-signed S3 upload URL for a new file.\n\nThis is step 1 of the **3-step upload flow**:\n\n1. **Get URL** — call this endpoint to receive a pre-signed `uploadUrl` and the\n   file metadata (id, url, s3Key).\n2. **Upload to S3** — `PUT` the file binary directly to the `uploadUrl` with the\n   matching `Content-Type` header.\n3. **Confirm** — call `POST /api/media-manager/explorer/confirm/{id}` to verify\n   the file exists on S3 and activate it.\n\nThe file is created with `status=pending` until confirmed.\n\nSupported content types: `image/jpeg`, `image/png`, `image/gif`, `image/webp`,\n`image/svg+xml`.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                            },
                            "response": [
                                {
                                    "name": "Pre-signed upload URL and file metadata.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/upload-url",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "upload-url"
                                            ]
                                        },
                                        "description": "Generates a pre-signed S3 upload URL for a new file.\n\nThis is step 1 of the **3-step upload flow**:\n\n1. **Get URL** — call this endpoint to receive a pre-signed `uploadUrl` and the\n   file metadata (id, url, s3Key).\n2. **Upload to S3** — `PUT` the file binary directly to the `uploadUrl` with the\n   matching `Content-Type` header.\n3. **Confirm** — call `POST /api/media-manager/explorer/confirm/{id}` to verify\n   the file exists on S3 and activate it.\n\nThe file is created with `status=pending` until confirmed.\n\nSupported content types: `image/jpeg`, `image/png`, `image/gif`, `image/webp`,\n`image/svg+xml`.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 101,\n    \"uploadUrl\": \"https://s3.us-east-2.amazonaws.com/bucket/org/101-hero-banner.jpg?X-Amz-Signature=...\",\n    \"url\": \"https://cdn.example.com/org/101-hero-banner.jpg\",\n    \"s3Key\": \"org/101-hero-banner.jpg\",\n    \"expiresAt\": \"2026-06-23T15:30:00Z\"\n}"
                                },
                                {
                                    "name": "Invalid or unsupported content type.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/api/media-manager/explorer/upload-url",
                                            "path": [
                                                "api",
                                                "media-manager",
                                                "explorer",
                                                "upload-url"
                                            ]
                                        },
                                        "description": "Generates a pre-signed S3 upload URL for a new file.\n\nThis is step 1 of the **3-step upload flow**:\n\n1. **Get URL** — call this endpoint to receive a pre-signed `uploadUrl` and the\n   file metadata (id, url, s3Key).\n2. **Upload to S3** — `PUT` the file binary directly to the `uploadUrl` with the\n   matching `Content-Type` header.\n3. **Confirm** — call `POST /api/media-manager/explorer/confirm/{id}` to verify\n   the file exists on S3 and activate it.\n\nThe file is created with `status=pending` until confirmed.\n\nSupported content types: `image/jpeg`, `image/png`, `image/gif`, `image/webp`,\n`image/svg+xml`.\n\nAuth: service-to-service RSA `signature` header.\nOrganization is taken from the request context (subdomain)."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Unsupported content type\" }"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Middlewares",
            "item": [
                {
                    "name": "CLIP",
                    "item": [
                        {
                            "name": "Devices (enroll & auth)",
                            "item": [
                                {
                                    "name": "Auth token (deviceToken → accessToken)",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/auth-token",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "auth-token"
                                            ]
                                        },
                                        "description": "**Public** (the `deviceToken` is the credential). Exchanges the stored\n`deviceToken` for a short-lived **HS256 JWT** (`accessToken`, ~15 min) used as\n`Authorization: Bearer` on all loyalty endpoints and `device-rename`.\n\nThe BFF hashes the `deviceToken`, looks up the active device and validates that\nthe device, store and organization are all active. A revoked device fails here\nimmediately. Call this whenever the access token is missing or expired.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"deviceToken\": \"bUja5ghRIrUw1kc_c05BpebqgKx1Ds1XAvTiK6wy45s\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Token issued. `expiresIn` is in seconds.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/auth-token",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "auth-token"
                                                    ]
                                                },
                                                "description": "**Public** (the `deviceToken` is the credential). Exchanges the stored\n`deviceToken` for a short-lived **HS256 JWT** (`accessToken`, ~15 min) used as\n`Authorization: Bearer` on all loyalty endpoints and `device-rename`.\n\nThe BFF hashes the `deviceToken`, looks up the active device and validates that\nthe device, store and organization are all active. A revoked device fails here\nimmediately. Call this whenever the access token is missing or expired.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"deviceToken\": \"bUja5ghRIrUw1kc_c05BpebqgKx1Ds1XAvTiK6wy45s\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n    \"expiresIn\": 900,\n    \"deviceId\": \"1e58528b-8f84-40be-9359-c423a0774be6\",\n    \"storeId\": \"c32cad3d-1ad5-4e41-95f1-9c06e965af58\"\n}"
                                        },
                                        {
                                            "name": "Missing `deviceToken`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/auth-token",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "auth-token"
                                                    ]
                                                },
                                                "description": "**Public** (the `deviceToken` is the credential). Exchanges the stored\n`deviceToken` for a short-lived **HS256 JWT** (`accessToken`, ~15 min) used as\n`Authorization: Bearer` on all loyalty endpoints and `device-rename`.\n\nThe BFF hashes the `deviceToken`, looks up the active device and validates that\nthe device, store and organization are all active. A revoked device fails here\nimmediately. Call this whenever the access token is missing or expired.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"deviceToken\": \"bUja5ghRIrUw1kc_c05BpebqgKx1Ds1XAvTiK6wy45s\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required fields\", \"missingFields\": [\"deviceToken\"] }"
                                        },
                                        {
                                            "name": "Unknown/revoked device, or store/organization inactive.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/auth-token",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "auth-token"
                                                    ]
                                                },
                                                "description": "**Public** (the `deviceToken` is the credential). Exchanges the stored\n`deviceToken` for a short-lived **HS256 JWT** (`accessToken`, ~15 min) used as\n`Authorization: Bearer` on all loyalty endpoints and `device-rename`.\n\nThe BFF hashes the `deviceToken`, looks up the active device and validates that\nthe device, store and organization are all active. A revoked device fails here\nimmediately. Call this whenever the access token is missing or expired.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"deviceToken\": \"bUja5ghRIrUw1kc_c05BpebqgKx1Ds1XAvTiK6wy45s\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"device_inactive_or_unknown\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Enroll a device (activate terminal)",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/devices-enroll",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "devices-enroll"
                                            ]
                                        },
                                        "description": "**Public.** First call a terminal makes. The operator types the **organization\nslug** and a short **8-digit pairing code** (generated in the Guper panel for a\nspecific store, valid ~15 min). The BFF validates the code **scoped to that org**,\ncreates the `device` and returns an opaque `deviceToken`.\n\nThe `deviceToken` is returned **only here** — store it in the device Keystore\n(hardware-backed). The BFF keeps only its sha-256 hash. The code is **single-use**\nand expires fast. The store (and therefore the Guper organization) is fixed by the\ncode — the app does not choose it.\n\nErrors are **generic** (`invalid_or_expired_code`) on purpose, to not reveal whether\na code exists/expired/was used. Enroll is **rate-limited per (org, IP)**: after 10\nfailed attempts in 15 min it returns `429`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"org\": \"cloe\",\n    \"code\": \"73129045\",\n    \"fingerprint\": \"a1b2c3-device-fingerprint\",\n    \"name\": \"Caixa 01\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Device created and code consumed. Persist `deviceToken` securely.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/devices-enroll",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "devices-enroll"
                                                    ]
                                                },
                                                "description": "**Public.** First call a terminal makes. The operator types the **organization\nslug** and a short **8-digit pairing code** (generated in the Guper panel for a\nspecific store, valid ~15 min). The BFF validates the code **scoped to that org**,\ncreates the `device` and returns an opaque `deviceToken`.\n\nThe `deviceToken` is returned **only here** — store it in the device Keystore\n(hardware-backed). The BFF keeps only its sha-256 hash. The code is **single-use**\nand expires fast. The store (and therefore the Guper organization) is fixed by the\ncode — the app does not choose it.\n\nErrors are **generic** (`invalid_or_expired_code`) on purpose, to not reveal whether\na code exists/expired/was used. Enroll is **rate-limited per (org, IP)**: after 10\nfailed attempts in 15 min it returns `429`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"org\": \"cloe\",\n    \"code\": \"73129045\",\n    \"fingerprint\": \"a1b2c3-device-fingerprint\",\n    \"name\": \"Caixa 01\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Created",
                                            "code": 201,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"deviceToken\": \"bUja5ghRIrUw1kc_c05BpebqgKx1Ds1XAvTiK6wy45s\",\n    \"deviceId\": \"1e58528b-8f84-40be-9359-c423a0774be6\",\n    \"storeId\": \"c32cad3d-1ad5-4e41-95f1-9c06e965af58\",\n    \"name\": \"Caixa 01\"\n}"
                                        },
                                        {
                                            "name": "Missing `org`, `code` or `fingerprint`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/devices-enroll",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "devices-enroll"
                                                    ]
                                                },
                                                "description": "**Public.** First call a terminal makes. The operator types the **organization\nslug** and a short **8-digit pairing code** (generated in the Guper panel for a\nspecific store, valid ~15 min). The BFF validates the code **scoped to that org**,\ncreates the `device` and returns an opaque `deviceToken`.\n\nThe `deviceToken` is returned **only here** — store it in the device Keystore\n(hardware-backed). The BFF keeps only its sha-256 hash. The code is **single-use**\nand expires fast. The store (and therefore the Guper organization) is fixed by the\ncode — the app does not choose it.\n\nErrors are **generic** (`invalid_or_expired_code`) on purpose, to not reveal whether\na code exists/expired/was used. Enroll is **rate-limited per (org, IP)**: after 10\nfailed attempts in 15 min it returns `429`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"org\": \"cloe\",\n    \"code\": \"73129045\",\n    \"fingerprint\": \"a1b2c3-device-fingerprint\",\n    \"name\": \"Caixa 01\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required fields\", \"missingFields\": [\"org\"] }"
                                        },
                                        {
                                            "name": "Unknown organization, or invalid/expired/used code (generic).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/devices-enroll",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "devices-enroll"
                                                    ]
                                                },
                                                "description": "**Public.** First call a terminal makes. The operator types the **organization\nslug** and a short **8-digit pairing code** (generated in the Guper panel for a\nspecific store, valid ~15 min). The BFF validates the code **scoped to that org**,\ncreates the `device` and returns an opaque `deviceToken`.\n\nThe `deviceToken` is returned **only here** — store it in the device Keystore\n(hardware-backed). The BFF keeps only its sha-256 hash. The code is **single-use**\nand expires fast. The store (and therefore the Guper organization) is fixed by the\ncode — the app does not choose it.\n\nErrors are **generic** (`invalid_or_expired_code`) on purpose, to not reveal whether\na code exists/expired/was used. Enroll is **rate-limited per (org, IP)**: after 10\nfailed attempts in 15 min it returns `429`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"org\": \"cloe\",\n    \"code\": \"73129045\",\n    \"fingerprint\": \"a1b2c3-device-fingerprint\",\n    \"name\": \"Caixa 01\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"invalid_or_expired_code\" }"
                                        },
                                        {
                                            "name": "Too many failed attempts for this (org, IP) — try again later.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/devices-enroll",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "devices-enroll"
                                                    ]
                                                },
                                                "description": "**Public.** First call a terminal makes. The operator types the **organization\nslug** and a short **8-digit pairing code** (generated in the Guper panel for a\nspecific store, valid ~15 min). The BFF validates the code **scoped to that org**,\ncreates the `device` and returns an opaque `deviceToken`.\n\nThe `deviceToken` is returned **only here** — store it in the device Keystore\n(hardware-backed). The BFF keeps only its sha-256 hash. The code is **single-use**\nand expires fast. The store (and therefore the Guper organization) is fixed by the\ncode — the app does not choose it.\n\nErrors are **generic** (`invalid_or_expired_code`) on purpose, to not reveal whether\na code exists/expired/was used. Enroll is **rate-limited per (org, IP)**: after 10\nfailed attempts in 15 min it returns `429`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"org\": \"cloe\",\n    \"code\": \"73129045\",\n    \"fingerprint\": \"a1b2c3-device-fingerprint\",\n    \"name\": \"Caixa 01\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 429,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"too_many_attempts\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Rename device",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/device-rename",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "device-rename"
                                            ]
                                        },
                                        "description": "Updates the friendly name of the device that owns the access token. Useful for\nsettings screens (\"Caixa 01\" → \"Balcão\"). Requires `Authorization: Bearer`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Balcão Principal\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Device renamed.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/device-rename",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "device-rename"
                                                    ]
                                                },
                                                "description": "Updates the friendly name of the device that owns the access token. Useful for\nsettings screens (\"Caixa 01\" → \"Balcão\"). Requires `Authorization: Bearer`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Balcão Principal\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"name\": \"Balcão Principal\" }"
                                        },
                                        {
                                            "name": "Missing `name`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/device-rename",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "device-rename"
                                                    ]
                                                },
                                                "description": "Updates the friendly name of the device that owns the access token. Useful for\nsettings screens (\"Caixa 01\" → \"Balcão\"). Requires `Authorization: Bearer`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Balcão Principal\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required fields\", \"missingFields\": [\"name\"] }"
                                        },
                                        {
                                            "name": "Missing/invalid/expired Bearer token, or device revoked.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/device-rename",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "device-rename"
                                                    ]
                                                },
                                                "description": "Updates the friendly name of the device that owns the access token. Useful for\nsettings screens (\"Caixa 01\" → \"Balcão\"). Requires `Authorization: Bearer`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Balcão Principal\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Invalid or expired accessToken\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Loyalty (sale flow)",
                            "item": [
                                {
                                    "name": "Customer balance",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-balance",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "loyalty-balance"
                                            ]
                                        },
                                        "description": "Looks the customer up by phone and returns their cashback balance. The BFF calls\nGuper `/register/customer` (exact match on the phone) to get the `customerId`, then\n`/loyalty/report/rewardBalances` over a wide window.\n\nThe phone is matched **literally** (E.164, e.g. `+52...`) — the BFF builds E.164 from\n`cellphone` + `countryCallingCode`. If the customer is not found, `found` is `false`\nand the other fields are omitted. Amounts in **cents**.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Customer found.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-balance",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-balance"
                                                    ]
                                                },
                                                "description": "Looks the customer up by phone and returns their cashback balance. The BFF calls\nGuper `/register/customer` (exact match on the phone) to get the `customerId`, then\n`/loyalty/report/rewardBalances` over a wide window.\n\nThe phone is matched **literally** (E.164, e.g. `+52...`) — the BFF builds E.164 from\n`cellphone` + `countryCallingCode`. If the customer is not found, `found` is `false`\nand the other fields are omitted. Amounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"found\": true,\n    \"customerId\": 542510,\n    \"name\": \"Marta Sauer\",\n    \"totalCents\": 1850,\n    \"availableCents\": 1850\n}"
                                        },
                                        {
                                            "name": "No customer for this phone.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-balance",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-balance"
                                                    ]
                                                },
                                                "description": "Looks the customer up by phone and returns their cashback balance. The BFF calls\nGuper `/register/customer` (exact match on the phone) to get the `customerId`, then\n`/loyalty/report/rewardBalances` over a wide window.\n\nThe phone is matched **literally** (E.164, e.g. `+52...`) — the BFF builds E.164 from\n`cellphone` + `countryCallingCode`. If the customer is not found, `found` is `false`\nand the other fields are omitted. Amounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"found\": false }"
                                        },
                                        {
                                            "name": "Missing `cellphone`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-balance",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-balance"
                                                    ]
                                                },
                                                "description": "Looks the customer up by phone and returns their cashback balance. The BFF calls\nGuper `/register/customer` (exact match on the phone) to get the `customerId`, then\n`/loyalty/report/rewardBalances` over a wide window.\n\nThe phone is matched **literally** (E.164, e.g. `+52...`) — the BFF builds E.164 from\n`cellphone` + `countryCallingCode`. If the customer is not found, `found` is `false`\nand the other fields are omitted. Amounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"cellphone é obrigatório\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Cancel a sale",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-cancel",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "loyalty-cancel"
                                            ]
                                        },
                                        "description": "Cancels a confirmed sale. The BFF reads the checkout's `tid` and calls Guper\n`/loyalty/cancelOrderByTransaction/{tid}`, then marks the checkout `canceled`.\n\n**Idempotent:** canceling an already-canceled sale still returns `200`\n(`alreadyCanceled: true`). The card refund on CLIP is handled separately (CLIP\n`refunds`), not by this endpoint.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Canceled (or already canceled).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-cancel",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-cancel"
                                                    ]
                                                },
                                                "description": "Cancels a confirmed sale. The BFF reads the checkout's `tid` and calls Guper\n`/loyalty/cancelOrderByTransaction/{tid}`, then marks the checkout `canceled`.\n\n**Idempotent:** canceling an already-canceled sale still returns `200`\n(`alreadyCanceled: true`). The card refund on CLIP is handled separately (CLIP\n`refunds`), not by this endpoint.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"canceled\": true, \"alreadyCanceled\": false }"
                                        },
                                        {
                                            "name": "Missing `checkoutId`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-cancel",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-cancel"
                                                    ]
                                                },
                                                "description": "Cancels a confirmed sale. The BFF reads the checkout's `tid` and calls Guper\n`/loyalty/cancelOrderByTransaction/{tid}`, then marks the checkout `canceled`.\n\n**Idempotent:** canceling an already-canceled sale still returns `200`\n(`alreadyCanceled: true`). The card refund on CLIP is handled separately (CLIP\n`refunds`), not by this endpoint.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"checkoutId é obrigatório\" }"
                                        },
                                        {
                                            "name": "Checkout has no `tid` (was never confirmed).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-cancel",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-cancel"
                                                    ]
                                                },
                                                "description": "Cancels a confirmed sale. The BFF reads the checkout's `tid` and calls Guper\n`/loyalty/cancelOrderByTransaction/{tid}`, then marks the checkout `canceled`.\n\n**Idempotent:** canceling an already-canceled sale still returns `200`\n(`alreadyCanceled: true`). The card refund on CLIP is handled separately (CLIP\n`refunds`), not by this endpoint.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"checkout sem tid (não confirmado)\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Confirm a sale",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "loyalty-confirm"
                                            ]
                                        },
                                        "description": "Second step. Call it **after the card is charged** by the CLIP terminal. The BFF\nrecovers the checkout's `confirmToken` (must belong to the same device) and calls\nGuper `/loyalty/confirmOrder/{confirmToken}`, then marks the checkout `confirmed`\nand stores the `tid`.\n\n**Idempotent:** if the checkout is already `confirmed` locally, or Guper returns\n`409`, the BFF responds `200` with `alreadyConfirmed: true`. On failure the checkout\nis marked `failed` for reconciliation. `orderId` is the CLIP charge **receiptNumber**.\n\n`redeemCents` (optional) is the amount to redeem; `card`/`payments` enrichment via\nCLIP is optional and not required to confirm.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"orderId\": \"CLIP-RCPT-88231\",\n    \"redeemCents\": 0,\n    \"finalCents\": 10000\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Confirmed (or already confirmed). `accumulatedOrderCents` is the awarded cashback.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-confirm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-confirm"
                                                    ]
                                                },
                                                "description": "Second step. Call it **after the card is charged** by the CLIP terminal. The BFF\nrecovers the checkout's `confirmToken` (must belong to the same device) and calls\nGuper `/loyalty/confirmOrder/{confirmToken}`, then marks the checkout `confirmed`\nand stores the `tid`.\n\n**Idempotent:** if the checkout is already `confirmed` locally, or Guper returns\n`409`, the BFF responds `200` with `alreadyConfirmed: true`. On failure the checkout\nis marked `failed` for reconciliation. `orderId` is the CLIP charge **receiptNumber**.\n\n`redeemCents` (optional) is the amount to redeem; `card`/`payments` enrichment via\nCLIP is optional and not required to confirm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"orderId\": \"CLIP-RCPT-88231\",\n    \"redeemCents\": 0,\n    \"finalCents\": 10000\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"accumulatedOrderCents\": 2000,\n    \"tid\": \"ee01a92adcce9dbd4fc8d0fe470e8f88678309d1b702300fd1698809f7e83112\",\n    \"confirmedAt\": \"2026-06-06T11:57:29-06:00\",\n    \"alreadyConfirmed\": false\n}"
                                        },
                                        {
                                            "name": "`checkoutId` or `orderId` missing.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-confirm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-confirm"
                                                    ]
                                                },
                                                "description": "Second step. Call it **after the card is charged** by the CLIP terminal. The BFF\nrecovers the checkout's `confirmToken` (must belong to the same device) and calls\nGuper `/loyalty/confirmOrder/{confirmToken}`, then marks the checkout `confirmed`\nand stores the `tid`.\n\n**Idempotent:** if the checkout is already `confirmed` locally, or Guper returns\n`409`, the BFF responds `200` with `alreadyConfirmed: true`. On failure the checkout\nis marked `failed` for reconciliation. `orderId` is the CLIP charge **receiptNumber**.\n\n`redeemCents` (optional) is the amount to redeem; `card`/`payments` enrichment via\nCLIP is optional and not required to confirm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"orderId\": \"CLIP-RCPT-88231\",\n    \"redeemCents\": 0,\n    \"finalCents\": 10000\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"checkoutId e orderId são obrigatórios\" }"
                                        },
                                        {
                                            "name": "Checkout belongs to a different device.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-confirm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-confirm"
                                                    ]
                                                },
                                                "description": "Second step. Call it **after the card is charged** by the CLIP terminal. The BFF\nrecovers the checkout's `confirmToken` (must belong to the same device) and calls\nGuper `/loyalty/confirmOrder/{confirmToken}`, then marks the checkout `confirmed`\nand stores the `tid`.\n\n**Idempotent:** if the checkout is already `confirmed` locally, or Guper returns\n`409`, the BFF responds `200` with `alreadyConfirmed: true`. On failure the checkout\nis marked `failed` for reconciliation. `orderId` is the CLIP charge **receiptNumber**.\n\n`redeemCents` (optional) is the amount to redeem; `card`/`payments` enrichment via\nCLIP is optional and not required to confirm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"orderId\": \"CLIP-RCPT-88231\",\n    \"redeemCents\": 0,\n    \"finalCents\": 10000\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Forbidden",
                                            "code": 403,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"checkout_belongs_to_another_device\" }"
                                        },
                                        {
                                            "name": "Checkout has no `confirmToken` (preview missing/expired).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-confirm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-confirm"
                                                    ]
                                                },
                                                "description": "Second step. Call it **after the card is charged** by the CLIP terminal. The BFF\nrecovers the checkout's `confirmToken` (must belong to the same device) and calls\nGuper `/loyalty/confirmOrder/{confirmToken}`, then marks the checkout `confirmed`\nand stores the `tid`.\n\n**Idempotent:** if the checkout is already `confirmed` locally, or Guper returns\n`409`, the BFF responds `200` with `alreadyConfirmed: true`. On failure the checkout\nis marked `failed` for reconciliation. `orderId` is the CLIP charge **receiptNumber**.\n\n`redeemCents` (optional) is the amount to redeem; `card`/`payments` enrichment via\nCLIP is optional and not required to confirm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"orderId\": \"CLIP-RCPT-88231\",\n    \"redeemCents\": 0,\n    \"finalCents\": 10000\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"checkout sem confirm_token (preview ausente/expirado)\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "List movements",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-movements",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "loyalty-movements"
                                            ]
                                        },
                                        "description": "Lists the store's recent sales (`confirmed`/`canceled`) from the BFF's own\n`loyalty_checkout` table, newest first. Use it for the terminal's \"history\" screen.\nRead straight from the BFF (no Guper call). Amounts in **cents**.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"limit\": 50\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Movements for the store of the authenticated device.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-movements",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-movements"
                                                    ]
                                                },
                                                "description": "Lists the store's recent sales (`confirmed`/`canceled`) from the BFF's own\n`loyalty_checkout` table, newest first. Use it for the terminal's \"history\" screen.\nRead straight from the BFF (no Guper call). Amounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"limit\": 50\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"movements\": [\n        {\n            \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n            \"orderId\": \"CLIP-RCPT-88231\",\n            \"tid\": \"ee01a92adcce9dbd4fc8d0fe470e8f88678309d1b702300fd1698809f7e83112\",\n            \"finalCents\": 10000,\n            \"accumulateCents\": 2000,\n            \"redeemCents\": null,\n            \"status\": \"confirmed\",\n            \"confirmedAt\": \"2026-06-06T17:57:29.773Z\"\n        }\n    ]\n}"
                                        },
                                        {
                                            "name": "Missing/invalid Bearer token.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-movements",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-movements"
                                                    ]
                                                },
                                                "description": "Lists the store's recent sales (`confirmed`/`canceled`) from the BFF's own\n`loyalty_checkout` table, newest first. Use it for the terminal's \"history\" screen.\nRead straight from the BFF (no Guper call). Amounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"limit\": 50\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Invalid or expired accessToken\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Preview cashback for a sale",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-preview",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "loyalty-preview"
                                            ]
                                        },
                                        "description": "First step of the 2-phase flow. Call it **before charging the card** to show the\nshopper what they'll earn (and, if identified, how much they can redeem). The app\ngenerates a `checkoutId` (UUID) and reuses it through confirm/cancel.\n\nThe BFF wraps Guper `/loyalty/rewardByOrder` (with the store's `guper_interface`\nand `guper_store_id`) and persists a `loyalty_checkout` row as `previewed` with the\nreturned `confirmToken`. Without `cellphone` you get accrual only (no customer\nbalance / redeemable).\n\nAll amounts are in **cents**. `baseCents` is the **consumption base** (no tip —\naccrual is computed over the base; the tip is added separately by the CLIP terminal).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"baseCents\": 10000,\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Preview computed and checkout saved as `previewed`. Amounts in cents.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-preview",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-preview"
                                                    ]
                                                },
                                                "description": "First step of the 2-phase flow. Call it **before charging the card** to show the\nshopper what they'll earn (and, if identified, how much they can redeem). The app\ngenerates a `checkoutId` (UUID) and reuses it through confirm/cancel.\n\nThe BFF wraps Guper `/loyalty/rewardByOrder` (with the store's `guper_interface`\nand `guper_store_id`) and persists a `loyalty_checkout` row as `previewed` with the\nreturned `confirmToken`. Without `cellphone` you get accrual only (no customer\nbalance / redeemable).\n\nAll amounts are in **cents**. `baseCents` is the **consumption base** (no tip —\naccrual is computed over the base; the tip is added separately by the CLIP terminal).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"baseCents\": 10000,\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"accumulateCents\": 2000,\n    \"redeemableCents\": 0,\n    \"userBalanceCents\": 0,\n    \"expiresAt\": \"2026-06-16T11:57:27-06:00\"\n}"
                                        },
                                        {
                                            "name": "`checkoutId` missing or `baseCents` not an integer.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-preview",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-preview"
                                                    ]
                                                },
                                                "description": "First step of the 2-phase flow. Call it **before charging the card** to show the\nshopper what they'll earn (and, if identified, how much they can redeem). The app\ngenerates a `checkoutId` (UUID) and reuses it through confirm/cancel.\n\nThe BFF wraps Guper `/loyalty/rewardByOrder` (with the store's `guper_interface`\nand `guper_store_id`) and persists a `loyalty_checkout` row as `previewed` with the\nreturned `confirmToken`. Without `cellphone` you get accrual only (no customer\nbalance / redeemable).\n\nAll amounts are in **cents**. `baseCents` is the **consumption base** (no tip —\naccrual is computed over the base; the tip is added separately by the CLIP terminal).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"baseCents\": 10000,\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"checkoutId e baseCents (inteiro, centavos) são obrigatórios\" }"
                                        },
                                        {
                                            "name": "Missing/invalid Bearer token.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-preview",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-preview"
                                                    ]
                                                },
                                                "description": "First step of the 2-phase flow. Call it **before charging the card** to show the\nshopper what they'll earn (and, if identified, how much they can redeem). The app\ngenerates a `checkoutId` (UUID) and reuses it through confirm/cancel.\n\nThe BFF wraps Guper `/loyalty/rewardByOrder` (with the store's `guper_interface`\nand `guper_store_id`) and persists a `loyalty_checkout` row as `previewed` with the\nreturned `confirmToken`. Without `cellphone` you get accrual only (no customer\nbalance / redeemable).\n\nAll amounts are in **cents**. `baseCents` is the **consumption base** (no tip —\naccrual is computed over the base; the tip is added separately by the CLIP terminal).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"checkoutId\": \"d1fc9c2e-67e4-40fa-b3a9-3750af5f208b\",\n    \"baseCents\": 10000,\n    \"cellphone\": \"+5215512345678\",\n    \"countryCallingCode\": \"52\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Invalid or expired accessToken\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Customer statement (cashback cards)",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-statement",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "clip",
                                                "loyalty-statement"
                                            ]
                                        },
                                        "description": "Returns the customer's cashback cards (batches) — campaign, initial/available\nbalance, validity window and status — ordered newest to oldest. The BFF wraps\nGuper `/loyalty/cards/full?q[client]={customerId}`. Get `customerId` from\n[Customer balance](/docs/{lang}/api-reference/middlewares/clip/loyalty/balance).\nAmounts in **cents**.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"customerId\": 542510\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Cards listed (may be empty).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-statement",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-statement"
                                                    ]
                                                },
                                                "description": "Returns the customer's cashback cards (batches) — campaign, initial/available\nbalance, validity window and status — ordered newest to oldest. The BFF wraps\nGuper `/loyalty/cards/full?q[client]={customerId}`. Get `customerId` from\n[Customer balance](/docs/{lang}/api-reference/middlewares/clip/loyalty/balance).\nAmounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"customerId\": 542510\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"cards\": [\n        {\n            \"cardId\": 101,\n            \"campaignName\": \"Cashback CLIP\",\n            \"initialBalanceCents\": 5000,\n            \"availableBalanceCents\": 2500,\n            \"startsAt\": \"2026-06-01T00:00:00-06:00\",\n            \"expiresAt\": \"2026-12-31T23:59:59-06:00\",\n            \"status\": \"active\"\n        }\n    ]\n}"
                                        },
                                        {
                                            "name": "Missing `customerId`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/clip/loyalty-statement",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "clip",
                                                        "loyalty-statement"
                                                    ]
                                                },
                                                "description": "Returns the customer's cashback cards (batches) — campaign, initial/available\nbalance, validity window and status — ordered newest to oldest. The BFF wraps\nGuper `/loyalty/cards/full?q[client]={customerId}`. Get `customerId` from\n[Customer balance](/docs/{lang}/api-reference/middlewares/clip/loyalty/balance).\nAmounts in **cents**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"customerId\": 542510\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"customerId é obrigatório\" }"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Shopify",
                    "item": [
                        {
                            "name": "Loyalty (balance & redeem)",
                            "item": [
                                {
                                    "name": "Get customer cashback balance",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/balance",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "loyalty",
                                                "balance"
                                            ]
                                        },
                                        "description": "Returns the customer's lifetime cashback ledger from Guper. Use this\non the storefront (\"My Account\" / cart drawer) to display how much\nthe shopper can spend right now (`available`) versus what's already\nbeen used or expired.\n\nWraps Guper [`/loyalty/report/rewardBalances`](/docs/{lang}/api-reference/loyalty/report/reward-balances)\nwith a fixed time window (`2020-01-01` → `2030-12-31`) — i.e. effectively\n\"all time\". Requires the customer to have been linked first via\n[Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)."
                                    },
                                    "response": [
                                        {
                                            "name": "Balance fetched. Amounts are in cents.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/balance",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "balance"
                                                    ]
                                                },
                                                "description": "Returns the customer's lifetime cashback ledger from Guper. Use this\non the storefront (\"My Account\" / cart drawer) to display how much\nthe shopper can spend right now (`available`) versus what's already\nbeen used or expired.\n\nWraps Guper [`/loyalty/report/rewardBalances`](/docs/{lang}/api-reference/loyalty/report/reward-balances)\nwith a fixed time window (`2020-01-01` → `2030-12-31`) — i.e. effectively\n\"all time\". Requires the customer to have been linked first via\n[Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"data\": {\n        \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n        \"guperCustomerId\": 8842,\n        \"total\": 1850,\n        \"available\": 1850,\n        \"expired\": 0,\n        \"used\": 0\n    }\n}"
                                        },
                                        {
                                            "name": "Missing one of the query params.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/balance",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "balance"
                                                    ]
                                                },
                                                "description": "Returns the customer's lifetime cashback ledger from Guper. Use this\non the storefront (\"My Account\" / cart drawer) to display how much\nthe shopper can spend right now (`available`) versus what's already\nbeen used or expired.\n\nWraps Guper [`/loyalty/report/rewardBalances`](/docs/{lang}/api-reference/loyalty/report/reward-balances)\nwith a fixed time window (`2020-01-01` → `2030-12-31`) — i.e. effectively\n\"all time\". Requires the customer to have been linked first via\n[Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)."
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required: shop, shopifyCustomerId\" }"
                                        },
                                        {
                                            "name": "No mapping for this Shopify customer. Front-end should prompt the shopper to connect their Guper account.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/balance",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "balance"
                                                    ]
                                                },
                                                "description": "Returns the customer's lifetime cashback ledger from Guper. Use this\non the storefront (\"My Account\" / cart drawer) to display how much\nthe shopper can spend right now (`available`) versus what's already\nbeen used or expired.\n\nWraps Guper [`/loyalty/report/rewardBalances`](/docs/{lang}/api-reference/loyalty/report/reward-balances)\nwith a fixed time window (`2020-01-01` → `2030-12-31`) — i.e. effectively\n\"all time\". Requires the customer to have been linked first via\n[Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Customer not linked to Guper\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Redeem cashback as discount",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/redeem",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "loyalty",
                                                "redeem"
                                            ]
                                        },
                                        "description": "Spends the customer's available cashback on a Shopify order in a\nsingle call. The endpoint orchestrates four Guper calls:\n\n1. `rewardByOrder` to compute the redeemable amount for the cart.\n2. `redeem/reserve/{confirmToken}` to reserve the spend.\n3. `redeem/reserve/{confirmToken}` (settle) — same URL as reserve at\n   the moment. Tracked as a known gotcha; see [services/mdw_shopify/DEPLOY.md](https://github.com/MyGuper/ai_suport/blob/main/services/mdw_shopify/DEPLOY.md).\n4. Persists a `Redemption` row with status `SUCCESS`.\n\nAmount redeemed equals `cashback.thisOrder.redeemable.total` from the\nfirst call — clients cannot choose a partial amount today. Fails\nwith `400` if the redeemable amount is `0`.\n\nRequires the customer to have a mapping (see [Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"orderId\": \"#4521\",\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Cashback redeemed. The `discountAmount` is in cents and should be applied as a discount line on the Shopify order.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/redeem",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "redeem"
                                                    ]
                                                },
                                                "description": "Spends the customer's available cashback on a Shopify order in a\nsingle call. The endpoint orchestrates four Guper calls:\n\n1. `rewardByOrder` to compute the redeemable amount for the cart.\n2. `redeem/reserve/{confirmToken}` to reserve the spend.\n3. `redeem/reserve/{confirmToken}` (settle) — same URL as reserve at\n   the moment. Tracked as a known gotcha; see [services/mdw_shopify/DEPLOY.md](https://github.com/MyGuper/ai_suport/blob/main/services/mdw_shopify/DEPLOY.md).\n4. Persists a `Redemption` row with status `SUCCESS`.\n\nAmount redeemed equals `cashback.thisOrder.redeemable.total` from the\nfirst call — clients cannot choose a partial amount today. Fails\nwith `400` if the redeemable amount is `0`.\n\nRequires the customer to have a mapping (see [Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"orderId\": \"#4521\",\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"Points redeemed successfully!\",\n    \"data\": {\n        \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n        \"pointsRedeemed\": 600,\n        \"discountAmount\": 600,\n        \"status\": \"SUCCESS\"\n    }\n}"
                                        },
                                        {
                                            "name": "Missing field, customer has no redeemable amount, or one of the Guper sub-calls failed (reserve/settle).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/redeem",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "redeem"
                                                    ]
                                                },
                                                "description": "Spends the customer's available cashback on a Shopify order in a\nsingle call. The endpoint orchestrates four Guper calls:\n\n1. `rewardByOrder` to compute the redeemable amount for the cart.\n2. `redeem/reserve/{confirmToken}` to reserve the spend.\n3. `redeem/reserve/{confirmToken}` (settle) — same URL as reserve at\n   the moment. Tracked as a known gotcha; see [services/mdw_shopify/DEPLOY.md](https://github.com/MyGuper/ai_suport/blob/main/services/mdw_shopify/DEPLOY.md).\n4. Persists a `Redemption` row with status `SUCCESS`.\n\nAmount redeemed equals `cashback.thisOrder.redeemable.total` from the\nfirst call — clients cannot choose a partial amount today. Fails\nwith `400` if the redeemable amount is `0`.\n\nRequires the customer to have a mapping (see [Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"orderId\": \"#4521\",\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"No redeemable points available\" }"
                                        },
                                        {
                                            "name": "Customer not linked to Guper yet.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/redeem",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "redeem"
                                                    ]
                                                },
                                                "description": "Spends the customer's available cashback on a Shopify order in a\nsingle call. The endpoint orchestrates four Guper calls:\n\n1. `rewardByOrder` to compute the redeemable amount for the cart.\n2. `redeem/reserve/{confirmToken}` to reserve the spend.\n3. `redeem/reserve/{confirmToken}` (settle) — same URL as reserve at\n   the moment. Tracked as a known gotcha; see [services/mdw_shopify/DEPLOY.md](https://github.com/MyGuper/ai_suport/blob/main/services/mdw_shopify/DEPLOY.md).\n4. Persists a `Redemption` row with status `SUCCESS`.\n\nAmount redeemed equals `cashback.thisOrder.redeemable.total` from the\nfirst call — clients cannot choose a partial amount today. Fails\nwith `400` if the redeemable amount is `0`.\n\nRequires the customer to have a mapping (see [Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect)).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"orderId\": \"#4521\",\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Customer not linked to Guper\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Refund order (reverse cashback)",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/refund",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "loyalty",
                                                "refund"
                                            ]
                                        },
                                        "description": "Cancels the cashback transaction associated with a previously\nconfirmed order. Call this when Shopify issues a refund (full or\npartial — we currently treat both as full reversal).\n\nWraps Guper [`/loyalty/cancelOrderByTransaction/{TID}`](/docs/{lang}/api-reference/loyalty/transaction/cancel-by-transaction).\nRequires the order to have been confirmed (i.e. have a `guperTID`).\n\nIdempotency: if the order is already `REFUNDED`, returns `409` instead\nof double-cancelling.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyOrderId\": \"#4521\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Cashback transaction cancelled. The order is now `REFUNDED` and the cashback amount is removed from the customer wallet on the Guper side.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/refund",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "refund"
                                                    ]
                                                },
                                                "description": "Cancels the cashback transaction associated with a previously\nconfirmed order. Call this when Shopify issues a refund (full or\npartial — we currently treat both as full reversal).\n\nWraps Guper [`/loyalty/cancelOrderByTransaction/{TID}`](/docs/{lang}/api-reference/loyalty/transaction/cancel-by-transaction).\nRequires the order to have been confirmed (i.e. have a `guperTID`).\n\nIdempotency: if the order is already `REFUNDED`, returns `409` instead\nof double-cancelling.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyOrderId\": \"#4521\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"Order refunded. Points reversed!\",\n    \"data\": {\n        \"orderId\": \"#4521\",\n        \"status\": \"REFUNDED\",\n        \"pointsReversed\": 600\n    }\n}"
                                        },
                                        {
                                            "name": "Either a required field is missing, or the order has no `guperTID` (not confirmed yet — call [Confirm Order](/docs/{lang}/api-reference/middlewares/shopify/reward/confirm) first), or Guper rejected the cancellation.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/refund",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "refund"
                                                    ]
                                                },
                                                "description": "Cancels the cashback transaction associated with a previously\nconfirmed order. Call this when Shopify issues a refund (full or\npartial — we currently treat both as full reversal).\n\nWraps Guper [`/loyalty/cancelOrderByTransaction/{TID}`](/docs/{lang}/api-reference/loyalty/transaction/cancel-by-transaction).\nRequires the order to have been confirmed (i.e. have a `guperTID`).\n\nIdempotency: if the order is already `REFUNDED`, returns `409` instead\nof double-cancelling.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyOrderId\": \"#4521\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Order not confirmed yet - cannot refund\" }"
                                        },
                                        {
                                            "name": "No order in the local DB with this `shopifyOrderId`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/refund",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "refund"
                                                    ]
                                                },
                                                "description": "Cancels the cashback transaction associated with a previously\nconfirmed order. Call this when Shopify issues a refund (full or\npartial — we currently treat both as full reversal).\n\nWraps Guper [`/loyalty/cancelOrderByTransaction/{TID}`](/docs/{lang}/api-reference/loyalty/transaction/cancel-by-transaction).\nRequires the order to have been confirmed (i.e. have a `guperTID`).\n\nIdempotency: if the order is already `REFUNDED`, returns `409` instead\nof double-cancelling.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyOrderId\": \"#4521\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Order not found\" }"
                                        },
                                        {
                                            "name": "Order is already in `REFUNDED` state. Treat as a successful no-op on retries.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/loyalty/refund",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "loyalty",
                                                        "refund"
                                                    ]
                                                },
                                                "description": "Cancels the cashback transaction associated with a previously\nconfirmed order. Call this when Shopify issues a refund (full or\npartial — we currently treat both as full reversal).\n\nWraps Guper [`/loyalty/cancelOrderByTransaction/{TID}`](/docs/{lang}/api-reference/loyalty/transaction/cancel-by-transaction).\nRequires the order to have been confirmed (i.e. have a `guperTID`).\n\nIdempotency: if the order is already `REFUNDED`, returns `409` instead\nof double-cancelling.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyOrderId\": \"#4521\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Order already refunded\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Members",
                            "item": [
                                {
                                    "name": "Connect Shopify customer to Guper",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/members/connect",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "members",
                                                "connect"
                                            ]
                                        },
                                        "description": "Bridges a Shopify customer to a Guper person:\n\n1. Calls `findOrCreate` on the Guper register service using the chosen\n   `identifierType` / `identifierValue` (and optionally name + phone).\n2. Persists the resulting Guper `id` on a `customer_mappings` row\n   keyed by `(shop, shopifyCustomerId)`.\n\nIdempotent: calling it twice with the same `(shop, shopifyCustomerId)`\nupdates the existing row instead of creating a duplicate.\n\n**Identifier priority on Guper side:** `cellphone` is the strongest\nmatch key in most organizations — see [Person matching](/docs/{lang}/guides/authentication#person-match)\nfor the matching algorithm.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"identifierType\": \"email\",\n    \"identifierValue\": \"ana@example.com\",\n    \"customerName\": \"Ana López\",\n    \"customerPhone\": \"+5215512345678\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Linked. `guperCustomerId` is the Guper person id you should reference on every subsequent call (balance, reward, redemption).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/members/connect",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "members",
                                                        "connect"
                                                    ]
                                                },
                                                "description": "Bridges a Shopify customer to a Guper person:\n\n1. Calls `findOrCreate` on the Guper register service using the chosen\n   `identifierType` / `identifierValue` (and optionally name + phone).\n2. Persists the resulting Guper `id` on a `customer_mappings` row\n   keyed by `(shop, shopifyCustomerId)`.\n\nIdempotent: calling it twice with the same `(shop, shopifyCustomerId)`\nupdates the existing row instead of creating a duplicate.\n\n**Identifier priority on Guper side:** `cellphone` is the strongest\nmatch key in most organizations — see [Person matching](/docs/{lang}/guides/authentication#person-match)\nfor the matching algorithm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"identifierType\": \"email\",\n    \"identifierValue\": \"ana@example.com\",\n    \"customerName\": \"Ana López\",\n    \"customerPhone\": \"+5215512345678\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"GUPER account connected successfully\",\n    \"data\": {\n        \"guperCustomerId\": 8842,\n        \"identifierType\": \"email\",\n        \"identifierValue\": \"ana@example.com\"\n    }\n}"
                                        },
                                        {
                                            "name": "Missing one of the 4 required fields.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/members/connect",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "members",
                                                        "connect"
                                                    ]
                                                },
                                                "description": "Bridges a Shopify customer to a Guper person:\n\n1. Calls `findOrCreate` on the Guper register service using the chosen\n   `identifierType` / `identifierValue` (and optionally name + phone).\n2. Persists the resulting Guper `id` on a `customer_mappings` row\n   keyed by `(shop, shopifyCustomerId)`.\n\nIdempotent: calling it twice with the same `(shop, shopifyCustomerId)`\nupdates the existing row instead of creating a duplicate.\n\n**Identifier priority on Guper side:** `cellphone` is the strongest\nmatch key in most organizations — see [Person matching](/docs/{lang}/guides/authentication#person-match)\nfor the matching algorithm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"identifierType\": \"email\",\n    \"identifierValue\": \"ana@example.com\",\n    \"customerName\": \"Ana López\",\n    \"customerPhone\": \"+5215512345678\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"All fields required: shop, shopifyCustomerId, identifierType, identifierValue\" }"
                                        },
                                        {
                                            "name": "`findOrCreate` failed on the Guper side (e.g. invalid cellphone format, org rejected the payload). Body carries the upstream message when available.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/members/connect",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "members",
                                                        "connect"
                                                    ]
                                                },
                                                "description": "Bridges a Shopify customer to a Guper person:\n\n1. Calls `findOrCreate` on the Guper register service using the chosen\n   `identifierType` / `identifierValue` (and optionally name + phone).\n2. Persists the resulting Guper `id` on a `customer_mappings` row\n   keyed by `(shop, shopifyCustomerId)`.\n\nIdempotent: calling it twice with the same `(shop, shopifyCustomerId)`\nupdates the existing row instead of creating a duplicate.\n\n**Identifier priority on Guper side:** `cellphone` is the strongest\nmatch key in most organizations — see [Person matching](/docs/{lang}/guides/authentication#person-match)\nfor the matching algorithm.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n    \"identifierType\": \"email\",\n    \"identifierValue\": \"ana@example.com\",\n    \"customerName\": \"Ana López\",\n    \"customerPhone\": \"+5215512345678\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Internal Server Error",
                                            "code": 500,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Failed to find or create Guper customer\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Merchant onboarding",
                            "item": [
                                {
                                    "name": "List merchant customers",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/customers/{{shop}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "merchant",
                                                "customers",
                                                "{{shop}}"
                                            ]
                                        },
                                        "description": "Returns every `customer_mappings` row for a shop — i.e. every Shopify\ncustomer that has been linked to a Guper person via [Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect).\nReturns an empty list when the shop has no mappings or doesn't exist\nyet (no 404 — this is a discovery endpoint)."
                                    },
                                    "response": [
                                        {
                                            "name": "Mappings (possibly empty).",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/customers/{{shop}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "customers",
                                                        "{{shop}}"
                                                    ]
                                                },
                                                "description": "Returns every `customer_mappings` row for a shop — i.e. every Shopify\ncustomer that has been linked to a Guper person via [Connect Member](/docs/{lang}/api-reference/middlewares/shopify/members/connect).\nReturns an empty list when the shop has no mappings or doesn't exist\nyet (no 404 — this is a discovery endpoint)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"data\": {\n        \"shop\": \"demoshop.myshopify.com\",\n        \"totalCustomers\": 2,\n        \"customers\": [\n            {\n                \"id\": 17,\n                \"shopifyCustomerId\": \"gid://shopify/Customer/5829304912\",\n                \"guperCustomerId\": 8842,\n                \"identifierType\": \"email\",\n                \"identifierValue\": \"ana@example.com\",\n                \"customerName\": \"Ana López\",\n                \"customerEmail\": \"ana@example.com\",\n                \"customerPhone\": null,\n                \"createdAt\": \"2026-05-14T03:24:01.000Z\"\n            }\n        ]\n    }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Save merchant credentials",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/save",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "merchant",
                                                "save"
                                            ]
                                        },
                                        "description": "Verifies the Guper credentials and upserts the merchant row keyed by\n`shop`. Triggers `invalidateTokenCache(shop)` so the next API call\nre-authenticates with the new credentials instead of using a stale\ncached token.\n\nThe `storeId` must match an existing Guper store the credentials have\naccess to — it is sent verbatim as `storeId` in [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"account\": \"demoshop\",\n    \"storeId\": \"1\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Merchant saved (created or updated). `isActive` is forced to `true` on save.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/save",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "save"
                                                    ]
                                                },
                                                "description": "Verifies the Guper credentials and upserts the merchant row keyed by\n`shop`. Triggers `invalidateTokenCache(shop)` so the next API call\nre-authenticates with the new credentials instead of using a stale\ncached token.\n\nThe `storeId` must match an existing Guper store the credentials have\naccess to — it is sent verbatim as `storeId` in [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"account\": \"demoshop\",\n    \"storeId\": \"1\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"Credentials verified and saved successfully\",\n    \"data\": {\n        \"shop\": \"demoshop.myshopify.com\",\n        \"account\": \"demoshop\",\n        \"storeId\": \"1\",\n        \"isActive\": true\n    }\n}"
                                        },
                                        {
                                            "name": "Guper rejected the credentials (same shape as [Verify](/docs/{lang}/api-reference/middlewares/shopify/merchant/verify)).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/save",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "save"
                                                    ]
                                                },
                                                "description": "Verifies the Guper credentials and upserts the merchant row keyed by\n`shop`. Triggers `invalidateTokenCache(shop)` so the next API call\nre-authenticates with the new credentials instead of using a stale\ncached token.\n\nThe `storeId` must match an existing Guper store the credentials have\naccess to — it is sent verbatim as `storeId` in [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"account\": \"demoshop\",\n    \"storeId\": \"1\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Invalid API Key or API Secret\" }"
                                        },
                                        {
                                            "name": "Missing one of the required fields.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/save",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "save"
                                                    ]
                                                },
                                                "description": "Verifies the Guper credentials and upserts the merchant row keyed by\n`shop`. Triggers `invalidateTokenCache(shop)` so the next API call\nre-authenticates with the new credentials instead of using a stale\ncached token.\n\nThe `storeId` must match an existing Guper store the credentials have\naccess to — it is sent verbatim as `storeId` in [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"account\": \"demoshop\",\n    \"storeId\": \"1\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required fields\", \"missingFields\": [\"shop\", \"storeId\"] }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Merchant stats",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/stats/{{shop}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "merchant",
                                                "stats",
                                                "{{shop}}"
                                            ]
                                        },
                                        "description": "Aggregate counters for the embedded admin dashboard. Reads only the\nlocal `mdw_shopify` tables — does **not** hit the Guper API — so it's\ncheap to poll. `totalPointsAwarded` is the sum of `cashbackAmount`\nover all `CONFIRMED` orders."
                                    },
                                    "response": [
                                        {
                                            "name": "Aggregates over the shop.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/stats/{{shop}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "stats",
                                                        "{{shop}}"
                                                    ]
                                                },
                                                "description": "Aggregate counters for the embedded admin dashboard. Reads only the\nlocal `mdw_shopify` tables — does **not** hit the Guper API — so it's\ncheap to poll. `totalPointsAwarded` is the sum of `cashbackAmount`\nover all `CONFIRMED` orders."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"data\": {\n        \"shop\": \"demoshop.myshopify.com\",\n        \"totalCustomers\": 142,\n        \"totalOrders\": 88,\n        \"totalPointsAwarded\": 12450,\n        \"totalRedemptions\": 17,\n        \"totalRefunds\": 3\n    }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get merchant status",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/status/{{shop}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "merchant",
                                                "status",
                                                "{{shop}}"
                                            ]
                                        },
                                        "description": "Returns the persisted merchant row for a given Shopify shop. Use it\nfrom the Shopify app embedded admin to render the connection state\nafter the merchant comes back. Does **not** call Guper."
                                    },
                                    "response": [
                                        {
                                            "name": "Merchant exists.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/status/{{shop}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "status",
                                                        "{{shop}}"
                                                    ]
                                                },
                                                "description": "Returns the persisted merchant row for a given Shopify shop. Use it\nfrom the Shopify app embedded admin to render the connection state\nafter the merchant comes back. Does **not** call Guper."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"data\": {\n        \"shop\": \"demoshop.myshopify.com\",\n        \"account\": \"demoshop\",\n        \"isActive\": true,\n        \"createdAt\": \"2026-05-14T03:21:14.000Z\"\n    }\n}"
                                        },
                                        {
                                            "name": "No merchant row for this shop. Treat this as \"not connected yet\" in the Shopify app UI and surface the credentials form.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/status/{{shop}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "status",
                                                        "{{shop}}"
                                                    ]
                                                },
                                                "description": "Returns the persisted merchant row for a given Shopify shop. Use it\nfrom the Shopify app embedded admin to render the connection state\nafter the merchant comes back. Does **not** call Guper."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Merchant not found\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Verify Guper credentials",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/verify",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "merchant",
                                                "verify"
                                            ]
                                        },
                                        "description": "Validates a pair of Guper `apiKey` / `apiSecret` against the merchant's\nGuper account without persisting anything. Use this from the Shopify app\nonboarding wizard to give the merchant immediate feedback that their\ncredentials are correct before calling [Save Credentials](/docs/{lang}/api-reference/middlewares/shopify/merchant/save).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"account\": \"demoshop\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Credentials valid. The returned `accessToken` is informational — `mdw_shopify` does **not** persist it from this endpoint; call [Save Credentials](/docs/{lang}/api-reference/middlewares/shopify/merchant/save) to register the merchant.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/verify",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "verify"
                                                    ]
                                                },
                                                "description": "Validates a pair of Guper `apiKey` / `apiSecret` against the merchant's\nGuper account without persisting anything. Use this from the Shopify app\nonboarding wizard to give the merchant immediate feedback that their\ncredentials are correct before calling [Save Credentials](/docs/{lang}/api-reference/middlewares/shopify/merchant/save).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"account\": \"demoshop\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"Guper credentials verified successfully\",\n    \"data\": {\n        \"account\": \"demoshop\",\n        \"accessToken\": \"eyJhbGciOiJSUzI1NiIs...\",\n        \"expiresIn\": \"3600\"\n    }\n}"
                                        },
                                        {
                                            "name": "Guper rejected the credentials. The `message` mirrors the upstream `reason_phrase` (\"Invalid API Key or API Secret\", \"Account not found\", etc.).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/verify",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "verify"
                                                    ]
                                                },
                                                "description": "Validates a pair of Guper `apiKey` / `apiSecret` against the merchant's\nGuper account without persisting anything. Use this from the Shopify app\nonboarding wizard to give the merchant immediate feedback that their\ncredentials are correct before calling [Save Credentials](/docs/{lang}/api-reference/middlewares/shopify/merchant/save).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"account\": \"demoshop\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Invalid API Key or API Secret\" }"
                                        },
                                        {
                                            "name": "Missing one of `account` / `apiKey` / `apiSecret`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/merchant/verify",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "merchant",
                                                        "verify"
                                                    ]
                                                },
                                                "description": "Validates a pair of Guper `apiKey` / `apiSecret` against the merchant's\nGuper account without persisting anything. Use this from the Shopify app\nonboarding wizard to give the merchant immediate feedback that their\ncredentials are correct before calling [Save Credentials](/docs/{lang}/api-reference/middlewares/shopify/merchant/save).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"account\": \"demoshop\",\n    \"apiKey\": \"pk_live_2f3a...\",\n    \"apiSecret\": \"sk_live_8c1e...\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required fields\", \"missingFields\": [\"apiSecret\"] }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Reward (accumulate)",
                            "item": [
                                {
                                    "name": "Calculate reward for an order",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/award",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "reward",
                                                "award"
                                            ]
                                        },
                                        "description": "First step of the 2-phase accumulate flow. Call this when the order\nenters a pending state (Shopify `checkout completed` event or the\nstorefront \"thank you\" page) to get the cashback Guper will award if\nthe order is confirmed.\n\nWraps Guper [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nand additionally:\n\n- Looks up `merchant.storeId` and sends it as `storeId` (no longer\n  hardcoded to `\"1\"` since v0.0.2).\n- Persists an `Order` row in `mdw_shopify` with status `PENDING` and\n  the returned `confirmToken`. Subsequent calls with the same\n  `orderId` return `409` — Award is **not** idempotent at the API\n  level; idempotency comes from the DB unique constraint on\n  `shopifyOrderId`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"orderId\": \"#4521\",\n    \"client\": {\n        \"id\": \"8842\",\n        \"email\": \"ana@example.com\",\n        \"name\": \"Ana López\"\n    },\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Reward calculated and order persisted as `PENDING`. Keep the `confirmToken` — it goes into [Confirm Order](/docs/{lang}/api-reference/middlewares/shopify/reward/confirm) when the order is actually paid.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/award",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "reward",
                                                        "award"
                                                    ]
                                                },
                                                "description": "First step of the 2-phase accumulate flow. Call this when the order\nenters a pending state (Shopify `checkout completed` event or the\nstorefront \"thank you\" page) to get the cashback Guper will award if\nthe order is confirmed.\n\nWraps Guper [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nand additionally:\n\n- Looks up `merchant.storeId` and sends it as `storeId` (no longer\n  hardcoded to `\"1\"` since v0.0.2).\n- Persists an `Order` row in `mdw_shopify` with status `PENDING` and\n  the returned `confirmToken`. Subsequent calls with the same\n  `orderId` return `409` — Award is **not** idempotent at the API\n  level; idempotency comes from the DB unique constraint on\n  `shopifyOrderId`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"orderId\": \"#4521\",\n    \"client\": {\n        \"id\": \"8842\",\n        \"email\": \"ana@example.com\",\n        \"name\": \"Ana López\"\n    },\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"Reward calculated and order saved\",\n    \"data\": {\n        \"orderId\": \"#4521\",\n        \"customerId\": 8842,\n        \"cashback\": {\n            \"thisOrder\": {\n                \"redeemable\": { \"total\": 0, \"item\": [] },\n                \"accumulating\": { \"total\": 600, \"points\": 600, \"item\": [] }\n            },\n            \"userBalance\": { \"total\": 1850, \"availableAmount\": 1850, \"points\": 1850 }\n        },\n        \"confirmToken\": \"rwt_2c19a1f3...\",\n        \"status\": \"PENDING\"\n    }\n}"
                                        },
                                        {
                                            "name": "Missing required field, empty `items`, or Guper rejected the payload.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/award",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "reward",
                                                        "award"
                                                    ]
                                                },
                                                "description": "First step of the 2-phase accumulate flow. Call this when the order\nenters a pending state (Shopify `checkout completed` event or the\nstorefront \"thank you\" page) to get the cashback Guper will award if\nthe order is confirmed.\n\nWraps Guper [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nand additionally:\n\n- Looks up `merchant.storeId` and sends it as `storeId` (no longer\n  hardcoded to `\"1\"` since v0.0.2).\n- Persists an `Order` row in `mdw_shopify` with status `PENDING` and\n  the returned `confirmToken`. Subsequent calls with the same\n  `orderId` return `409` — Award is **not** idempotent at the API\n  level; idempotency comes from the DB unique constraint on\n  `shopifyOrderId`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"orderId\": \"#4521\",\n    \"client\": {\n        \"id\": \"8842\",\n        \"email\": \"ana@example.com\",\n        \"name\": \"Ana López\"\n    },\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Missing required fields: shop, orderId, client, items\" }"
                                        },
                                        {
                                            "name": "An order with this `shopifyOrderId` already exists. Returns the existing record so the caller can decide whether to retry or skip.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/award",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "reward",
                                                        "award"
                                                    ]
                                                },
                                                "description": "First step of the 2-phase accumulate flow. Call this when the order\nenters a pending state (Shopify `checkout completed` event or the\nstorefront \"thank you\" page) to get the cashback Guper will award if\nthe order is confirmed.\n\nWraps Guper [`/loyalty/rewardByOrder`](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order)\nand additionally:\n\n- Looks up `merchant.storeId` and sends it as `storeId` (no longer\n  hardcoded to `\"1\"` since v0.0.2).\n- Persists an `Order` row in `mdw_shopify` with status `PENDING` and\n  the returned `confirmToken`. Subsequent calls with the same\n  `orderId` return `409` — Award is **not** idempotent at the API\n  level; idempotency comes from the DB unique constraint on\n  `shopifyOrderId`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"orderId\": \"#4521\",\n    \"client\": {\n        \"id\": \"8842\",\n        \"email\": \"ana@example.com\",\n        \"name\": \"Ana López\"\n    },\n    \"items\": [\n        {\n            \"id\": \"SKU-001\",\n            \"name\": \"Camiseta\",\n            \"quantity\": 1,\n            \"price\": 12000\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": false,\n    \"message\": \"Order already processed\",\n    \"data\": { \"orderId\": \"#4521\", \"status\": \"PENDING\" }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Confirm reward for an order",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints with a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/confirm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "mdw",
                                                "shopify",
                                                "api",
                                                "reward",
                                                "confirm"
                                            ]
                                        },
                                        "description": "Second step of the 2-phase accumulate flow. Call this when Shopify\ntransitions the order to `paid` / `fulfilled` (your choice — pick the\nearliest terminal state for your business). The Guper transaction\nmoves from pending to settled and the cashback is credited to the\ncustomer's wallet.\n\nWraps Guper [`/loyalty/confirmOrder/{confirmToken}`](/docs/{lang}/api-reference/loyalty/checkout/confirm-order)\nand additionally:\n\n- Updates the local `Order.status` to `CONFIRMED`.\n- Persists the Guper `TID` so [Refund Order](/docs/{lang}/api-reference/middlewares/shopify/loyalty/refund)\n  can cancel the transaction later.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"confirmToken\": \"rwt_2c19a1f3...\",\n    \"orderId\": \"#4521\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Order confirmed. The `cashback` block carries the actual amounts that landed on the customer (redeemed and accumulated). `TID` is the Guper transaction id and should be retained if you ever need to refund.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/confirm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "reward",
                                                        "confirm"
                                                    ]
                                                },
                                                "description": "Second step of the 2-phase accumulate flow. Call this when Shopify\ntransitions the order to `paid` / `fulfilled` (your choice — pick the\nearliest terminal state for your business). The Guper transaction\nmoves from pending to settled and the cashback is credited to the\ncustomer's wallet.\n\nWraps Guper [`/loyalty/confirmOrder/{confirmToken}`](/docs/{lang}/api-reference/loyalty/checkout/confirm-order)\nand additionally:\n\n- Updates the local `Order.status` to `CONFIRMED`.\n- Persists the Guper `TID` so [Refund Order](/docs/{lang}/api-reference/middlewares/shopify/loyalty/refund)\n  can cancel the transaction later.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"confirmToken\": \"rwt_2c19a1f3...\",\n    \"orderId\": \"#4521\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"success\": true,\n    \"message\": \"Order confirmed. Points credited!\",\n    \"data\": {\n        \"orderId\": \"#4521\",\n        \"status\": \"CONFIRMED\",\n        \"cashback\": {\n            \"redeemedOrder\": 0,\n            \"accumulatedOrder\": 600\n        }\n    }\n}"
                                        },
                                        {
                                            "name": "Missing field, or Guper rejected confirmation (token expired, already confirmed, etc.).",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints with a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/mdw/shopify/api/reward/confirm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "mdw",
                                                        "shopify",
                                                        "api",
                                                        "reward",
                                                        "confirm"
                                                    ]
                                                },
                                                "description": "Second step of the 2-phase accumulate flow. Call this when Shopify\ntransitions the order to `paid` / `fulfilled` (your choice — pick the\nearliest terminal state for your business). The Guper transaction\nmoves from pending to settled and the cashback is credited to the\ncustomer's wallet.\n\nWraps Guper [`/loyalty/confirmOrder/{confirmToken}`](/docs/{lang}/api-reference/loyalty/checkout/confirm-order)\nand additionally:\n\n- Updates the local `Order.status` to `CONFIRMED`.\n- Persists the Guper `TID` so [Refund Order](/docs/{lang}/api-reference/middlewares/shopify/loyalty/refund)\n  can cancel the transaction later.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shop\": \"demoshop.myshopify.com\",\n    \"confirmToken\": \"rwt_2c19a1f3...\",\n    \"orderId\": \"#4521\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": false, \"message\": \"Failed to confirm order\" }"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "VTEX",
                    "item": [
                        {
                            "name": "Giftcards (giftCardHub)",
                            "item": [
                                {
                                    "name": "Cancel transaction (VTEX callback)",
                                    "request": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/giftcards/{{giftcards}}/transactions/{{transactions}}/cancellations",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "giftcards",
                                                "{{giftcards}}",
                                                "transactions",
                                                "{{transactions}}",
                                                "cancellations"
                                            ]
                                        },
                                        "description": "VTEX releases the reservation (checkout abandoned, payment failed, etc). Guper restores the balance to the wallet."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/giftcards/{{giftcards}}/transactions/{{transactions}}/cancellations",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "giftcards",
                                                        "{{giftcards}}",
                                                        "transactions",
                                                        "{{transactions}}",
                                                        "cancellations"
                                                    ]
                                                },
                                                "description": "VTEX releases the reservation (checkout abandoned, payment failed, etc). Guper restores the balance to the wallet."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"cancellationId\": \"guper-cancel-uvw\"}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Authorize transaction (VTEX callback)",
                                    "request": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/giftcards/{{giftcards}}/transactions",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "giftcards",
                                                "{{giftcards}}",
                                                "transactions"
                                            ]
                                        },
                                        "description": "VTEX calls this to **reserve** part of the giftcard balance during checkout. Guper validates the amount, locks the reservation against the cashback wallet and returns an `authorizationId` that VTEX will use to confirm (settlement) or release (cancellation).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"value\": 1500,\n    \"requestId\": \"vtex-req-123\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/giftcards/{{giftcards}}/transactions",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "giftcards",
                                                        "{{giftcards}}",
                                                        "transactions"
                                                    ]
                                                },
                                                "description": "VTEX calls this to **reserve** part of the giftcard balance during checkout. Guper validates the amount, locks the reservation against the cashback wallet and returns an `authorizationId` that VTEX will use to confirm (settlement) or release (cancellation).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"value\": 1500,\n    \"requestId\": \"vtex-req-123\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Created",
                                            "code": 201,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"authorizationId\": \"guper-auth-abc\", \"value\": 1500, \"requestId\": \"vtex-req-123\"}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get giftcard (VTEX callback)",
                                    "request": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/giftcards/{{giftcards}}",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "giftcards",
                                                "{{giftcards}}"
                                            ]
                                        },
                                        "description": "VTEX requests the current state of a specific giftcard (typically called between search and transaction)."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/giftcards/{{giftcards}}",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "giftcards",
                                                        "{{giftcards}}"
                                                    ]
                                                },
                                                "description": "VTEX requests the current state of a specific giftcard (typically called between search and transaction)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\": \"cashback-wallet-1\", \"value\": 5000, \"balance\": 5000, \"caption\": \"Cashback\"}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Search giftcards (VTEX callback)",
                                    "request": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/giftcards/_search",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "giftcards",
                                                "_search"
                                            ]
                                        },
                                        "description": "VTEX calls this when the customer reaches the checkout payment step. Guper looks up the customer by `userEmail` and/or `userProfileId`, computes their available cashback balance and returns one virtual giftcard per available wallet. **Called by VTEX checkout, not by orgs.**",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"userEmail\": \"cliente@example.com\",\n    \"userProfileId\": \"profile-uuid\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/giftcards/_search",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "giftcards",
                                                        "_search"
                                                    ]
                                                },
                                                "description": "VTEX calls this when the customer reaches the checkout payment step. Guper looks up the customer by `userEmail` and/or `userProfileId`, computes their available cashback balance and returns one virtual giftcard per available wallet. **Called by VTEX checkout, not by orgs.**",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"userEmail\": \"cliente@example.com\",\n    \"userProfileId\": \"profile-uuid\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Created",
                                            "code": 201,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"id\": \"cashback-wallet-1\",\n        \"redemptionCode\": \"...\",\n        \"value\": 5000,\n        \"balance\": 5000,\n        \"caption\": \"Cashback\",\n        \"profileId\": \"profile-uuid\",\n        \"groupName\": \"loyalty\",\n        \"provider\": \"giftcard-provider-guper\"\n    }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Settle transaction (VTEX callback)",
                                    "request": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/giftcards/{{giftcards}}/transactions/{{transactions}}/settlements",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "giftcards",
                                                "{{giftcards}}",
                                                "transactions",
                                                "{{transactions}}",
                                                "settlements"
                                            ]
                                        },
                                        "description": "VTEX confirms the reserved transaction (order was placed). Guper consumes the balance from the wallet (movement = redeem).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"value\": 1500\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/giftcards/{{giftcards}}/transactions/{{transactions}}/settlements",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "giftcards",
                                                        "{{giftcards}}",
                                                        "transactions",
                                                        "{{transactions}}",
                                                        "settlements"
                                                    ]
                                                },
                                                "description": "VTEX confirms the reserved transaction (order was placed). Guper consumes the balance from the wallet (movement = redeem).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"value\": 1500\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Created",
                                            "code": 201,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"settleId\": \"guper-settle-xyz\", \"value\": 1500}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Ping",
                            "request": {
                                "method": "GET",
                                "header": [],
                                "url": {
                                    "raw": "/mdw/vtex/ping",
                                    "path": [
                                        "mdw",
                                        "vtex",
                                        "ping"
                                    ]
                                },
                                "description": "Liveness probe — returns simple pong response. Requires user token auth."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/ping",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "ping"
                                            ]
                                        },
                                        "description": "Liveness probe — returns simple pong response. Requires user token auth."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"pong\":true}"
                                }
                            ]
                        },
                        {
                            "name": "Settings",
                            "item": [
                                {
                                    "name": "Create setting",
                                    "request": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/setting",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "setting"
                                            ]
                                        },
                                        "description": "Creates a VTEX setting row for the org. `appKey` and `account` are required — get them from the VTEX admin (`/admin/storeconfig` and `vtexAppKey`).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"account\": \"mystore\",\n    \"appKey\": \"vtexappkey-mystore-XXXX\",\n    \"appToken\": \"AAA...\",\n    \"integrateBrand\": 1,\n    \"integrateCategory\": 1,\n    \"integrateOrder\": 1,\n    \"sellersAvailableReward\": null,\n    \"giftcardProvider\": \"https://mystore.myguper.com/mdw/vtex\",\n    \"giftcardApiKey\": \"XXX\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/setting",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "setting"
                                                    ]
                                                },
                                                "description": "Creates a VTEX setting row for the org. `appKey` and `account` are required — get them from the VTEX admin (`/admin/storeconfig` and `vtexAppKey`).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"account\": \"mystore\",\n    \"appKey\": \"vtexappkey-mystore-XXXX\",\n    \"appToken\": \"AAA...\",\n    \"integrateBrand\": 1,\n    \"integrateCategory\": 1,\n    \"integrateOrder\": 1,\n    \"sellersAvailableReward\": null,\n    \"giftcardProvider\": \"https://mystore.myguper.com/mdw/vtex\",\n    \"giftcardApiKey\": \"XXX\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Created",
                                            "code": 201,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\": 1, \"account\": \"mystore\", \"appKey\": \"vtexappkey-mystore-XXXX\", \"integrateBrand\": 1, \"integrateCategory\": 1, \"integrateOrder\": 1}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete setting",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/setting",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "setting"
                                            ]
                                        },
                                        "description": "Removes a VTEX setting row. After delete, all VTEX integration for the org stops (no callbacks accepted, no sync).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/setting",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "setting"
                                                    ]
                                                },
                                                "description": "Removes a VTEX setting row. After delete, all VTEX integration for the org stops (no callbacks accepted, no sync).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"deleted\": true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List settings",
                                    "request": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/setting",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "setting"
                                            ]
                                        },
                                        "description": "Returns the VTEX settings of the org. Supports the standard listing query params."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/setting",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "setting"
                                                    ]
                                                },
                                                "description": "Returns the VTEX settings of the org. Supports the standard listing query params."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        {\n            \"id\": 1,\n            \"account\": \"mystore\",\n            \"appKey\": \"vtexappkey-mystore-XXXX\",\n            \"appToken\": \"AAA...\",\n            \"integrateBrand\": 1,\n            \"integrateCategory\": 1,\n            \"integrateOrder\": 1,\n            \"giftcardProvider\": \"https://mystore.myguper.com/api/middleware/vtex\",\n            \"sellersAvailableReward\": null,\n            \"feedStatus\": null\n        }\n    ],\n    \"total\": 1,\n    \"pagination\": {\"entries\": 50, \"currentPage\": 1, \"totalPages\": 1}\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update setting",
                                    "request": {
                                        "method": "PUT",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/setting",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "setting"
                                            ]
                                        },
                                        "description": "Updates a VTEX setting row. `id`, `appKey` and `account` are required (body-level).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"account\": \"mystore\",\n    \"appKey\": \"vtexappkey-mystore-XXXX\",\n    \"appToken\": \"AAA...\",\n    \"integrateBrand\": 1,\n    \"integrateCategory\": 1,\n    \"integrateOrder\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/setting",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "setting"
                                                    ]
                                                },
                                                "description": "Updates a VTEX setting row. `id`, `appKey` and `account` are required (body-level).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"account\": \"mystore\",\n    \"appKey\": \"vtexappkey-mystore-XXXX\",\n    \"appToken\": \"AAA...\",\n    \"integrateBrand\": 1,\n    \"integrateCategory\": 1,\n    \"integrateOrder\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\": 1, \"account\": \"mystore\", \"appKey\": \"vtexappkey-mystore-XXXX\"}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Sync Order",
                            "item": [
                                {
                                    "name": "Trigger sync",
                                    "request": {
                                        "method": "POST",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/sync-order",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "sync-order"
                                            ]
                                        },
                                        "description": "Schedules a sync period. The CRON walks the period in chunks (`steps`), fetching orders from VTEX day-by-day. Already-imported orders are deduped by VTEX `orderId`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"interface\": \"vtex\",\n    \"start\": \"2026-06-01\",\n    \"end\": \"2026-06-25\",\n    \"steps\": 4\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/sync-order",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "sync-order"
                                                    ]
                                                },
                                                "description": "Schedules a sync period. The CRON walks the period in chunks (`steps`), fetching orders from VTEX day-by-day. Already-imported orders are deduped by VTEX `orderId`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"interface\": \"vtex\",\n    \"start\": \"2026-06-01\",\n    \"end\": \"2026-06-25\",\n    \"steps\": 4\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Created",
                                            "code": 201,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"exists\": true,\n    \"active\": true,\n    \"start\": \"2026-06-01T00:00:00-03:00\",\n    \"end\": \"2026-06-25T23:59:59-03:00\",\n    \"current\": null,\n    \"steps\": 4,\n    \"attempt\": 0\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Sync status",
                                    "request": {
                                        "method": "GET",
                                        "header": [],
                                        "url": {
                                            "raw": "/mdw/vtex/sync-order",
                                            "path": [
                                                "mdw",
                                                "vtex",
                                                "sync-order"
                                            ]
                                        },
                                        "description": "Returns the current sync period state for the given `interface` query param. If no period exists, returns `{exists: false}`."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [],
                                                "url": {
                                                    "raw": "/mdw/vtex/sync-order",
                                                    "path": [
                                                        "mdw",
                                                        "vtex",
                                                        "sync-order"
                                                    ]
                                                },
                                                "description": "Returns the current sync period state for the given `interface` query param. If no period exists, returns `{exists: false}`."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"exists\": true,\n    \"active\": true,\n    \"start\": \"2026-06-01T00:00:00-03:00\",\n    \"end\": \"2026-06-25T23:59:59-03:00\",\n    \"current\": \"2026-06-20T00:00:00-03:00\",\n    \"steps\": 4,\n    \"attempt\": 0\n}"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Order",
            "item": [
                {
                    "name": "Campaign",
                    "item": [
                        {
                            "name": "List Campaign Attributions",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/campaign",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "campaign"
                                    ]
                                },
                                "description": "Campaigns a sale is attributed to. Answers both directions: filter by `order` for\n\"which campaigns is this sale attributed to\", or by `campaign` for \"which sales did\nthis campaign generate\".\n\nA sale is attributed to a campaign in two ways: the customer **redeemed** balance from\nit (`cashback`, `point`, `coupon`), or the customer **received a message** from it and\nbought within the attribution window (`notification`). A campaign that *rewarded* the\nsale is not an attribution — the reward is a consequence of the sale, not its cause.\n\nThe same sale may be attributed to the same campaign through more than one origin, and\nthrough more than one redeemed card. Each is a separate row. Count distinct orders, not\nrows, to measure conversion.\n\nThis mirrors `customerCampaignAttribution` in loyalty, which is the authoritative\nrecord — the redemption attribution is written by a database trigger when the redemption\nis confirmed. Rows arrive here right after that, through a call from loyalty."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/campaign",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "campaign"
                                            ]
                                        },
                                        "description": "Campaigns a sale is attributed to. Answers both directions: filter by `order` for\n\"which campaigns is this sale attributed to\", or by `campaign` for \"which sales did\nthis campaign generate\".\n\nA sale is attributed to a campaign in two ways: the customer **redeemed** balance from\nit (`cashback`, `point`, `coupon`), or the customer **received a message** from it and\nbought within the attribution window (`notification`). A campaign that *rewarded* the\nsale is not an attribution — the reward is a consequence of the sale, not its cause.\n\nThe same sale may be attributed to the same campaign through more than one origin, and\nthrough more than one redeemed card. Each is a separate row. Count distinct orders, not\nrows, to measure conversion.\n\nThis mirrors `customerCampaignAttribution` in loyalty, which is the authoritative\nrecord — the redemption attribution is written by a database trigger when the redemption\nis confirmed. Rows arrive here right after that, through a call from loyalty."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"order\": 6021077,\n            \"campaign\": 457,\n            \"origin\": \"notification\",\n            \"assetId\": \"B1BCBD0518B3F93C9E47A59971C0E304FD7BEA806E01A6A45CC438F692232684\",\n            \"campaignType\": \"monetary\",\n            \"value\": 0,\n            \"attributedAt\": \"2026-08-13 16:11:03\",\n            \"notifiedAt\": \"2026-07-31 23:21:30\",\n            \"windowEndsAt\": \"2026-09-01 02:59:59\",\n            \"createdAt\": \"2026-08-13 16:11:03\"\n        },\n        {\n            \"order\": 6021077,\n            \"campaign\": 457,\n            \"origin\": \"cashback\",\n            \"assetId\": \"CD24D2E0AF5DDF020BCCEE84195226DF0813CB7563B2ECFF8A23D6D2A95049C6C3\",\n            \"campaignType\": \"monetary\",\n            \"value\": 76485,\n            \"attributedAt\": \"2026-08-13 16:11:02\",\n            \"notifiedAt\": null,\n            \"windowEndsAt\": null,\n            \"createdAt\": \"2026-08-13 16:11:03\"\n        }\n    ],\n    \"total\": 2,\n    \"pages\": 1,\n    \"page\": 1\n}"
                                }
                            ]
                        },
                        {
                            "name": "Campaign Revenue Report",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/report/campaign/{{campaignId}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "report",
                                        "campaign",
                                        "{{campaignId}}"
                                    ]
                                },
                                "description": "How many sales a campaign was attributed and how much they were worth.\n\nAttribution means the customer **redeemed** balance from the campaign (`cashback`,\n`point`, `coupon`), or **received a message** from it and bought within the attribution\nwindow (`notification`). Sales the campaign merely rewarded are not counted — the reward\nis a consequence of the sale, not its cause.\n\nThis lives in the order service because the sale value does. The loyalty campaign report\nmeasures the *benefit* (credited, redeemed, outstanding balance); this one measures the\n*revenue*. They answer different questions and will not match.\n\n**`byOrigin` does not add up to `total`, by design.** A sale attributed through more than\none origin counts once in each. `total` counts distinct orders, so it is always less than\nor equal to the sum of `byOrigin`.\n\n**Attribution is not incrementality.** These sales may have happened anyway — the customer\nhad balance and used it, but might have bought regardless. Read this as *influenced*\nrevenue, not generated. Measuring real impact requires a control group.\n\nCancelled orders are excluded — revenue from a reverted sale is not revenue.\n\nAll monetary values are integers in cents, in the organization's currency. `revenueGross`\nis the order total **before** the redeemed balance is taken out; `revenueNet` subtracts it\nand is what came in as money. `avgDiscount` is `redeemed / revenueGross` (a ratio),\n`averageTicketGross` is `revenueGross / orders` and `averageTicketNet` is\n`revenueNet / orders`, all over distinct orders; the gap between the two tickets is the\naverage balance applied per order.\n\n`baseline` is the ruler: orders **not** attributed to this campaign, in the same window and\norganization. Without it an absolute revenue figure always looks good. It is cached (the\nquery is expensive and the value moves slowly), so it carries its own `computedAt` and is\nnot from the same instant as the rest of the payload.\n\nWhen no period is given, the window runs from the first to the last attributed order —\ncomparing against all-time would fill the baseline with periods when the campaign did not\nexist. `period.explicit` tells which of the two happened.\n\nThe date range is all-or-nothing. Informing only one of the two returns `404` — the route\nitself does not match with a single date. Half a window silently ignored would return\nall-time numbers wearing the requested period's face."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/campaign/{{campaignId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "campaign",
                                                "{{campaignId}}"
                                            ]
                                        },
                                        "description": "How many sales a campaign was attributed and how much they were worth.\n\nAttribution means the customer **redeemed** balance from the campaign (`cashback`,\n`point`, `coupon`), or **received a message** from it and bought within the attribution\nwindow (`notification`). Sales the campaign merely rewarded are not counted — the reward\nis a consequence of the sale, not its cause.\n\nThis lives in the order service because the sale value does. The loyalty campaign report\nmeasures the *benefit* (credited, redeemed, outstanding balance); this one measures the\n*revenue*. They answer different questions and will not match.\n\n**`byOrigin` does not add up to `total`, by design.** A sale attributed through more than\none origin counts once in each. `total` counts distinct orders, so it is always less than\nor equal to the sum of `byOrigin`.\n\n**Attribution is not incrementality.** These sales may have happened anyway — the customer\nhad balance and used it, but might have bought regardless. Read this as *influenced*\nrevenue, not generated. Measuring real impact requires a control group.\n\nCancelled orders are excluded — revenue from a reverted sale is not revenue.\n\nAll monetary values are integers in cents, in the organization's currency. `revenueGross`\nis the order total **before** the redeemed balance is taken out; `revenueNet` subtracts it\nand is what came in as money. `avgDiscount` is `redeemed / revenueGross` (a ratio),\n`averageTicketGross` is `revenueGross / orders` and `averageTicketNet` is\n`revenueNet / orders`, all over distinct orders; the gap between the two tickets is the\naverage balance applied per order.\n\n`baseline` is the ruler: orders **not** attributed to this campaign, in the same window and\norganization. Without it an absolute revenue figure always looks good. It is cached (the\nquery is expensive and the value moves slowly), so it carries its own `computedAt` and is\nnot from the same instant as the rest of the payload.\n\nWhen no period is given, the window runs from the first to the last attributed order —\ncomparing against all-time would fill the baseline with periods when the campaign did not\nexist. `period.explicit` tells which of the two happened.\n\nThe date range is all-or-nothing. Informing only one of the two returns `404` — the route\nitself does not match with a single date. Half a window silently ignored would return\nall-time numbers wearing the requested period's face."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"meta\": {\n        \"unit\": \"cents\",\n        \"attribution\": {\n            \"rule\": \"Venda atribuida a campanha cujo saldo foi resgatado (cashback/point/coupon), ou cuja mensagem o cliente recebeu e comprou dentro da janela (notification). Campanha que apenas premiou a venda NAO entra.\",\n            \"caveat\": \"Atribuicao nao e incrementalidade: a venda pode ter acontecido de qualquer forma. Ler como receita INFLUENCIADA, nao gerada. Medir impacto real exige grupo de controle.\"\n        },\n        \"notes\": {\n            \"revenueGross\": \"total_order dos pedidos atribuidos. Bruto: o resgate NAO esta descontado.\",\n            \"revenueNet\": \"revenueGross - redeemed. O que entrou como dinheiro.\",\n            \"returnOnBenefit\": \"revenueGross / redeemed. Sobre o RESGATADO, nao o creditado.\",\n            \"baseline\": \"Pedidos NAO atribuidos a esta campanha, mesma janela e organizacao.\",\n            \"byOrigin\": \"Nao soma com total: pedido atribuido por mais de uma origem conta uma vez em cada.\"\n        }\n    },\n    \"campaign\": 361,\n    \"period\": {\n        \"start\": \"2025-12-06\",\n        \"end\": \"2026-08-17\",\n        \"explicit\": false\n    },\n    \"total\": {\n        \"orders\": 10254,\n        \"clients\": 8538,\n        \"revenueGross\": 1904183642,\n        \"redeemed\": 333571751,\n        \"revenueNet\": 1570611891,\n        \"averageTicket\": 185702,\n        \"avgDiscount\": 0.1752,\n        \"averageTicketGross\": 185702,\n        \"averageTicketNet\": 153171,\n        \"returnOnBenefit\": 5.71\n    },\n    \"baseline\": {\n        \"orders\": 185201,\n        \"averageTicket\": 280407,\n        \"ticketDeltaPct\": -33.8,\n        \"computedAt\": \"2026-08-17 18:02:09\"\n    },\n    \"repeat\": {\n        \"clients\": 8538,\n        \"repeatClients\": 1330,\n        \"repeatRate\": 15.6,\n        \"ordersPerClient\": 1.2\n    },\n    \"byOrigin\": [\n        {\n            \"origin\": \"cashback\",\n            \"orders\": 10254,\n            \"revenueGross\": 1904183642,\n            \"averageTicket\": 185702\n        }\n    ]\n}"
                                },
                                {
                                    "name": "dateStart is after dateEnd.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/campaign/{{campaignId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "campaign",
                                                "{{campaignId}}"
                                            ]
                                        },
                                        "description": "How many sales a campaign was attributed and how much they were worth.\n\nAttribution means the customer **redeemed** balance from the campaign (`cashback`,\n`point`, `coupon`), or **received a message** from it and bought within the attribution\nwindow (`notification`). Sales the campaign merely rewarded are not counted — the reward\nis a consequence of the sale, not its cause.\n\nThis lives in the order service because the sale value does. The loyalty campaign report\nmeasures the *benefit* (credited, redeemed, outstanding balance); this one measures the\n*revenue*. They answer different questions and will not match.\n\n**`byOrigin` does not add up to `total`, by design.** A sale attributed through more than\none origin counts once in each. `total` counts distinct orders, so it is always less than\nor equal to the sum of `byOrigin`.\n\n**Attribution is not incrementality.** These sales may have happened anyway — the customer\nhad balance and used it, but might have bought regardless. Read this as *influenced*\nrevenue, not generated. Measuring real impact requires a control group.\n\nCancelled orders are excluded — revenue from a reverted sale is not revenue.\n\nAll monetary values are integers in cents, in the organization's currency. `revenueGross`\nis the order total **before** the redeemed balance is taken out; `revenueNet` subtracts it\nand is what came in as money. `avgDiscount` is `redeemed / revenueGross` (a ratio),\n`averageTicketGross` is `revenueGross / orders` and `averageTicketNet` is\n`revenueNet / orders`, all over distinct orders; the gap between the two tickets is the\naverage balance applied per order.\n\n`baseline` is the ruler: orders **not** attributed to this campaign, in the same window and\norganization. Without it an absolute revenue figure always looks good. It is cached (the\nquery is expensive and the value moves slowly), so it carries its own `computedAt` and is\nnot from the same instant as the rest of the payload.\n\nWhen no period is given, the window runs from the first to the last attributed order —\ncomparing against all-time would fill the baseline with periods when the campaign did not\nexist. `period.explicit` tells which of the two happened.\n\nThe date range is all-or-nothing. Informing only one of the two returns `404` — the route\nitself does not match with a single date. Half a window silently ignored would return\nall-time numbers wearing the requested period's face."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\"error\":true,\"message\":\"dateStart must not be after dateEnd\"}"
                                },
                                {
                                    "name": "Only one of dateStart / dateEnd was informed — no route matches a single date.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/campaign/{{campaignId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "campaign",
                                                "{{campaignId}}"
                                            ]
                                        },
                                        "description": "How many sales a campaign was attributed and how much they were worth.\n\nAttribution means the customer **redeemed** balance from the campaign (`cashback`,\n`point`, `coupon`), or **received a message** from it and bought within the attribution\nwindow (`notification`). Sales the campaign merely rewarded are not counted — the reward\nis a consequence of the sale, not its cause.\n\nThis lives in the order service because the sale value does. The loyalty campaign report\nmeasures the *benefit* (credited, redeemed, outstanding balance); this one measures the\n*revenue*. They answer different questions and will not match.\n\n**`byOrigin` does not add up to `total`, by design.** A sale attributed through more than\none origin counts once in each. `total` counts distinct orders, so it is always less than\nor equal to the sum of `byOrigin`.\n\n**Attribution is not incrementality.** These sales may have happened anyway — the customer\nhad balance and used it, but might have bought regardless. Read this as *influenced*\nrevenue, not generated. Measuring real impact requires a control group.\n\nCancelled orders are excluded — revenue from a reverted sale is not revenue.\n\nAll monetary values are integers in cents, in the organization's currency. `revenueGross`\nis the order total **before** the redeemed balance is taken out; `revenueNet` subtracts it\nand is what came in as money. `avgDiscount` is `redeemed / revenueGross` (a ratio),\n`averageTicketGross` is `revenueGross / orders` and `averageTicketNet` is\n`revenueNet / orders`, all over distinct orders; the gap between the two tickets is the\naverage balance applied per order.\n\n`baseline` is the ruler: orders **not** attributed to this campaign, in the same window and\norganization. Without it an absolute revenue figure always looks good. It is cached (the\nquery is expensive and the value moves slowly), so it carries its own `computedAt` and is\nnot from the same instant as the rest of the payload.\n\nWhen no period is given, the window runs from the first to the last attributed order —\ncomparing against all-time would fill the baseline with periods when the campaign did not\nexist. `period.explicit` tells which of the two happened.\n\nThe date range is all-or-nothing. Informing only one of the two returns `404` — the route\nitself does not match with a single date. Half a window silently ignored would return\nall-time numbers wearing the requested period's face."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Cancellation",
                    "request": {
                        "method": "PATCH",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/order/{{orderId}}/cancellation",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "order",
                                "{{orderId}}",
                                "cancellation"
                            ]
                        },
                        "description": "Marks an order as cancelled. Triggers cancellation of any related loyalty transactions."
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "PATCH",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/{{orderId}}/cancellation",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "{{orderId}}",
                                        "cancellation"
                                    ]
                                },
                                "description": "Marks an order as cancelled. Triggers cancellation of any related loyalty transactions."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"id\": 1672059,\n    \"interface\": \"generic\",\n    \"refId\": \"362\",\n    \"store\": 32,\n    \"cashier\": null,\n    \"salesperson\": null,\n    \"client\": 431969,\n    \"status\": \"cancelled\",\n    \"paidValue\": 0,\n    \"total_order\": 97390,\n    \"total_item\": 96390,\n    \"total_shipping\": 20000,\n    \"total_taxes\": 0,\n    \"total_discounts\": 1000,\n    \"order_date\": {\n        \"date\": \"2024-09-27 11:54:57.000000\",\n        \"timezone_type\": 3,\n        \"timezone\": \"America/Sao_Paulo\"\n    },\n    \"createAt\": {\n        \"date\": \"2024-09-27 11:55:02.000000\",\n        \"timezone_type\": 3,\n        \"timezone\": \"America/Sao_Paulo\"\n    },\n    \"updateAt\": {\n        \"date\": \"2024-09-27 11:55:02.000000\",\n        \"timezone_type\": 3,\n        \"timezone\": \"America/Sao_Paulo\"\n    }\n}"
                        }
                    ]
                },
                {
                    "name": "Complete",
                    "request": {
                        "method": "PATCH",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/order/{{orderId}}/complete",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "order",
                                "{{orderId}}",
                                "complete"
                            ]
                        },
                        "description": "Marks an order as completed (delivered / fulfilled / finalised). Settles any pending loyalty transactions tied to it."
                    },
                    "response": [
                        {
                            "name": "Completed",
                            "originalRequest": {
                                "method": "PATCH",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/{{orderId}}/complete",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "{{orderId}}",
                                        "complete"
                                    ]
                                },
                                "description": "Marks an order as completed (delivered / fulfilled / finalised). Settles any pending loyalty transactions tied to it."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"orderId\": 121212,\n    \"status\": \"completed\",\n    \"completedAt\": \"2026-05-01T12:34:56-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "CSAT",
                    "item": [
                        {
                            "name": "Update by Interface and RefId",
                            "request": {
                                "method": "PATCH",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/{{interface}}/{{refId}}/csat",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "{{interface}}",
                                        "{{refId}}",
                                        "csat"
                                    ]
                                },
                                "description": "Updates the customer satisfaction (CSAT) score for an order, identified by external `interface` + `refId`.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"csat\": 5\r\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "PATCH",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/{{interface}}/{{refId}}/csat",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "{{interface}}",
                                                "{{refId}}",
                                                "csat"
                                            ]
                                        },
                                        "description": "Updates the customer satisfaction (CSAT) score for an order, identified by external `interface` + `refId`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"csat\": 5\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 3833678,\n    \"organization\": \"xpto\",\n    \"interface\": \"generic\",\n    \"refId\": \"id-97.897.466\",\n    \"csat\": 5\n}"
                                }
                            ]
                        },
                        {
                            "name": "Update by Order Id",
                            "request": {
                                "method": "PATCH",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/{{orderId}}/csat",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "{{orderId}}",
                                        "csat"
                                    ]
                                },
                                "description": "Updates the customer satisfaction (CSAT) score for an order, identified by internal `orderId`.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"csat\": 5\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "PATCH",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/{{orderId}}/csat",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "{{orderId}}",
                                                "csat"
                                            ]
                                        },
                                        "description": "Updates the customer satisfaction (CSAT) score for an order, identified by internal `orderId`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"csat\": 5\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 3833678,\n    \"organization\": \"xpto\",\n    \"interface\": \"generic\",\n    \"refId\": \"id-97.897.466\",\n    \"csat\": 5\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Feed",
                    "item": [
                        {
                            "name": "Commit items",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/feed",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "feed"
                                    ]
                                },
                                "description": "Acknowledges consumption of order feed entries by sending the tokens back. Once acknowledged, those entries no longer appear in subsequent reads.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"tokens\": [\r\n        \"94d1499024f3d14a8d4376ecae6b20e09bf909e7\"\r\n    ]\r\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Acknowledged",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/feed",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "feed"
                                            ]
                                        },
                                        "description": "Acknowledges consumption of order feed entries by sending the tokens back. Once acknowledged, those entries no longer appear in subsequent reads.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"tokens\": [\r\n        \"94d1499024f3d14a8d4376ecae6b20e09bf909e7\"\r\n    ]\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"acknowledged\": 2\n}"
                                }
                            ]
                        },
                        {
                            "name": "Retrieve items",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/feed",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "feed"
                                    ]
                                },
                                "description": "Retrieves pending entries from the order feed (orders that were created, modified, cancelled or had rewards applied since the last acknowledgement)."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/feed",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "feed"
                                            ]
                                        },
                                        "description": "Retrieves pending entries from the order feed (orders that were created, modified, cancelled or had rewards applied since the last acknowledgement)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "[\n    {\n        \"confirmToken\": \"2A0067C7FECB11EFAAC602B02E860C9532173\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"order\",\n        \"key\": 71918412,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T16:50:00-03:00\"\n    },\n    {\n        \"confirmToken\": \"409FBC97FED111EFAAC602B02E860C9578560\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"order\",\n        \"key\": 71928432,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T17:33:35-03:00\"\n    },\n    {\n        \"confirmToken\": \"65as4d6as85d49qd51q69we54q9w58de496sa\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"order\",\n        \"key\": 71896943,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T14:41:14-03:00\"\n    },\n    {\n        \"confirmToken\": \"8374E01DFEC111EFAAC602B02E860C9555273\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"order\",\n        \"key\": 71906811,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T15:40:55-03:00\"\n    }\n]"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Order",
                    "item": [
                        {
                            "name": "Import",
                            "item": [
                                {
                                    "name": "Batch Import",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/import",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "import"
                                            ]
                                        },
                                        "description": "Imports multiple purchase orders in a single request. Use this endpoint to push large datasets — each\nitem in `purchases` is processed independently and the response is a parallel array with the outcome\nof each one (success or per-row error).\n\n**Single or batch, same endpoint.** When the body has no `purchases` array, the whole body is\ntreated as one purchase (`$perLot = array_key_exists('purchases', $body)`), so there is no\nseparate route for importing a single order.\n\nIdentification of an order is the pair `interface` + `refId` (or `interface` + `id`, treated as alias).\nThe optional `config.mode` controls what happens when the order already exists in the organization:\n\n| Mode | Behaviour |\n| --- | --- |\n| `append` *(default)* | Fail if order already exists. |\n| `upsert` | Update if exists, create otherwise. |\n| `update-unmatched` | Update if exists; if not, create with status `orphaned_import`. |\n| `replace` | *(planned — currently throws)* |\n| `skip-duplicates` | *(planned — currently throws)* |\n\nThe first import for a refId is also stored as the `originalOrderData`, so the original payload is\npreserved even if the order is later updated.\n\nMonetary fields are always **integer cents**. See [Monetary values](/guides/monetary-values).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"config\": { \"mode\": \"upsert\" },\n    \"purchases\": [\n        {\n            \"interface\": \"generic\",\n            \"storeId\": \"1\",\n            \"id\": \"908192165\",\n            \"creationDate\": \"2023-01-15 10:45:37\",\n            \"status\": \"completed\",\n            \"client\": {\n                \"id\": \"123123\",\n                \"name\": \"tintin\",\n                \"email\": \"tintin@gmail.com\",\n                \"cellphone\": \"11112356549\"\n            },\n            \"items\": [\n                {\n                    \"skuId\": \"47142\",\n                    \"name\": \"Sandalia Salto Alto 38\",\n                    \"categoryId\": 1186,\n                    \"brandId\": 69367,\n                    \"quantity\": 1,\n                    \"price\": 4448,\n                    \"listPrice\": 4448,\n                    \"tax\": 0\n                }\n            ],\n            \"payments\": [\n                {\n                    \"paymentSystem\": \"4fa\",\n                    \"paymentSystemName\": \"Mastercard\",\n                    \"type\": \"creditCard\",\n                    \"value\": 5447,\n                    \"installments\": 3,\n                    \"firstDigits\": \"550209\",\n                    \"lastDigits\": \"2569\"\n                }\n            ],\n            \"shipping\": [\n                {\n                    \"id\": \"AA123456785BR\",\n                    \"courierId\": \"correios-br\",\n                    \"courierName\": \"Correios\",\n                    \"price\": 999,\n                    \"listPrice\": 999\n                }\n            ],\n            \"total_item\": 4448,\n            \"total_discounts\": 0,\n            \"total_shipping\": 999,\n            \"total_tax\": 0\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "One result per purchase. Successful rows return `{ id, refId, status }`; failed rows return\n`{ id, error: true, code, message }`. Both shapes can appear in the same response.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/order/import",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "order",
                                                        "import"
                                                    ]
                                                },
                                                "description": "Imports multiple purchase orders in a single request. Use this endpoint to push large datasets — each\nitem in `purchases` is processed independently and the response is a parallel array with the outcome\nof each one (success or per-row error).\n\n**Single or batch, same endpoint.** When the body has no `purchases` array, the whole body is\ntreated as one purchase (`$perLot = array_key_exists('purchases', $body)`), so there is no\nseparate route for importing a single order.\n\nIdentification of an order is the pair `interface` + `refId` (or `interface` + `id`, treated as alias).\nThe optional `config.mode` controls what happens when the order already exists in the organization:\n\n| Mode | Behaviour |\n| --- | --- |\n| `append` *(default)* | Fail if order already exists. |\n| `upsert` | Update if exists, create otherwise. |\n| `update-unmatched` | Update if exists; if not, create with status `orphaned_import`. |\n| `replace` | *(planned — currently throws)* |\n| `skip-duplicates` | *(planned — currently throws)* |\n\nThe first import for a refId is also stored as the `originalOrderData`, so the original payload is\npreserved even if the order is later updated.\n\nMonetary fields are always **integer cents**. See [Monetary values](/guides/monetary-values).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"config\": { \"mode\": \"upsert\" },\n    \"purchases\": [\n        {\n            \"interface\": \"generic\",\n            \"storeId\": \"1\",\n            \"id\": \"908192165\",\n            \"creationDate\": \"2023-01-15 10:45:37\",\n            \"status\": \"completed\",\n            \"client\": {\n                \"id\": \"123123\",\n                \"name\": \"tintin\",\n                \"email\": \"tintin@gmail.com\",\n                \"cellphone\": \"11112356549\"\n            },\n            \"items\": [\n                {\n                    \"skuId\": \"47142\",\n                    \"name\": \"Sandalia Salto Alto 38\",\n                    \"categoryId\": 1186,\n                    \"brandId\": 69367,\n                    \"quantity\": 1,\n                    \"price\": 4448,\n                    \"listPrice\": 4448,\n                    \"tax\": 0\n                }\n            ],\n            \"payments\": [\n                {\n                    \"paymentSystem\": \"4fa\",\n                    \"paymentSystemName\": \"Mastercard\",\n                    \"type\": \"creditCard\",\n                    \"value\": 5447,\n                    \"installments\": 3,\n                    \"firstDigits\": \"550209\",\n                    \"lastDigits\": \"2569\"\n                }\n            ],\n            \"shipping\": [\n                {\n                    \"id\": \"AA123456785BR\",\n                    \"courierId\": \"correios-br\",\n                    \"courierName\": \"Correios\",\n                    \"price\": 999,\n                    \"listPrice\": 999\n                }\n            ],\n            \"total_item\": 4448,\n            \"total_discounts\": 0,\n            \"total_shipping\": 999,\n            \"total_tax\": 0\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"id\": 2138,\n        \"refId\": \"908192165\",\n        \"status\": \"pending\"\n    },\n    {\n        \"id\": \"767378586\",\n        \"error\": true,\n        \"code\": 409,\n        \"message\": \"Order already exists\"\n    }\n]"
                                        },
                                        {
                                            "name": "Body is not valid JSON or required top-level fields are missing.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/order/import",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "order",
                                                        "import"
                                                    ]
                                                },
                                                "description": "Imports multiple purchase orders in a single request. Use this endpoint to push large datasets — each\nitem in `purchases` is processed independently and the response is a parallel array with the outcome\nof each one (success or per-row error).\n\n**Single or batch, same endpoint.** When the body has no `purchases` array, the whole body is\ntreated as one purchase (`$perLot = array_key_exists('purchases', $body)`), so there is no\nseparate route for importing a single order.\n\nIdentification of an order is the pair `interface` + `refId` (or `interface` + `id`, treated as alias).\nThe optional `config.mode` controls what happens when the order already exists in the organization:\n\n| Mode | Behaviour |\n| --- | --- |\n| `append` *(default)* | Fail if order already exists. |\n| `upsert` | Update if exists, create otherwise. |\n| `update-unmatched` | Update if exists; if not, create with status `orphaned_import`. |\n| `replace` | *(planned — currently throws)* |\n| `skip-duplicates` | *(planned — currently throws)* |\n\nThe first import for a refId is also stored as the `originalOrderData`, so the original payload is\npreserved even if the order is later updated.\n\nMonetary fields are always **integer cents**. See [Monetary values](/guides/monetary-values).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"config\": { \"mode\": \"upsert\" },\n    \"purchases\": [\n        {\n            \"interface\": \"generic\",\n            \"storeId\": \"1\",\n            \"id\": \"908192165\",\n            \"creationDate\": \"2023-01-15 10:45:37\",\n            \"status\": \"completed\",\n            \"client\": {\n                \"id\": \"123123\",\n                \"name\": \"tintin\",\n                \"email\": \"tintin@gmail.com\",\n                \"cellphone\": \"11112356549\"\n            },\n            \"items\": [\n                {\n                    \"skuId\": \"47142\",\n                    \"name\": \"Sandalia Salto Alto 38\",\n                    \"categoryId\": 1186,\n                    \"brandId\": 69367,\n                    \"quantity\": 1,\n                    \"price\": 4448,\n                    \"listPrice\": 4448,\n                    \"tax\": 0\n                }\n            ],\n            \"payments\": [\n                {\n                    \"paymentSystem\": \"4fa\",\n                    \"paymentSystemName\": \"Mastercard\",\n                    \"type\": \"creditCard\",\n                    \"value\": 5447,\n                    \"installments\": 3,\n                    \"firstDigits\": \"550209\",\n                    \"lastDigits\": \"2569\"\n                }\n            ],\n            \"shipping\": [\n                {\n                    \"id\": \"AA123456785BR\",\n                    \"courierId\": \"correios-br\",\n                    \"courierName\": \"Correios\",\n                    \"price\": 999,\n                    \"listPrice\": 999\n                }\n            ],\n            \"total_item\": 4448,\n            \"total_discounts\": 0,\n            \"total_shipping\": 999,\n            \"total_tax\": 0\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"Json parameters are missing: ( interface, refId ) or ( interface, id ) or ( purchases )\" }"
                                        },
                                        {
                                            "name": "`purchases` array is empty.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/order/import",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "order",
                                                        "import"
                                                    ]
                                                },
                                                "description": "Imports multiple purchase orders in a single request. Use this endpoint to push large datasets — each\nitem in `purchases` is processed independently and the response is a parallel array with the outcome\nof each one (success or per-row error).\n\n**Single or batch, same endpoint.** When the body has no `purchases` array, the whole body is\ntreated as one purchase (`$perLot = array_key_exists('purchases', $body)`), so there is no\nseparate route for importing a single order.\n\nIdentification of an order is the pair `interface` + `refId` (or `interface` + `id`, treated as alias).\nThe optional `config.mode` controls what happens when the order already exists in the organization:\n\n| Mode | Behaviour |\n| --- | --- |\n| `append` *(default)* | Fail if order already exists. |\n| `upsert` | Update if exists, create otherwise. |\n| `update-unmatched` | Update if exists; if not, create with status `orphaned_import`. |\n| `replace` | *(planned — currently throws)* |\n| `skip-duplicates` | *(planned — currently throws)* |\n\nThe first import for a refId is also stored as the `originalOrderData`, so the original payload is\npreserved even if the order is later updated.\n\nMonetary fields are always **integer cents**. See [Monetary values](/guides/monetary-values).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"config\": { \"mode\": \"upsert\" },\n    \"purchases\": [\n        {\n            \"interface\": \"generic\",\n            \"storeId\": \"1\",\n            \"id\": \"908192165\",\n            \"creationDate\": \"2023-01-15 10:45:37\",\n            \"status\": \"completed\",\n            \"client\": {\n                \"id\": \"123123\",\n                \"name\": \"tintin\",\n                \"email\": \"tintin@gmail.com\",\n                \"cellphone\": \"11112356549\"\n            },\n            \"items\": [\n                {\n                    \"skuId\": \"47142\",\n                    \"name\": \"Sandalia Salto Alto 38\",\n                    \"categoryId\": 1186,\n                    \"brandId\": 69367,\n                    \"quantity\": 1,\n                    \"price\": 4448,\n                    \"listPrice\": 4448,\n                    \"tax\": 0\n                }\n            ],\n            \"payments\": [\n                {\n                    \"paymentSystem\": \"4fa\",\n                    \"paymentSystemName\": \"Mastercard\",\n                    \"type\": \"creditCard\",\n                    \"value\": 5447,\n                    \"installments\": 3,\n                    \"firstDigits\": \"550209\",\n                    \"lastDigits\": \"2569\"\n                }\n            ],\n            \"shipping\": [\n                {\n                    \"id\": \"AA123456785BR\",\n                    \"courierId\": \"correios-br\",\n                    \"courierName\": \"Correios\",\n                    \"price\": 999,\n                    \"listPrice\": 999\n                }\n            ],\n            \"total_item\": 4448,\n            \"total_discounts\": 0,\n            \"total_shipping\": 999,\n            \"total_tax\": 0\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"Purchases empty\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "List Orders — a customer's orders",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/data",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "data"
                                    ]
                                },
                                "description": "Returns a paginated list of orders, and **filters through the shared listing grammar**\n`q[column][operator]=value` - see [List query parameters](/docs/{lang}/guides/list-query-parameters)\nfor the full operator table.\n\n**Only these columns are filterable** (an unlisted column returns `400 Coluna nao\npermitida`): `status` (registered | completed | canceled), `orderStatus`, `client`,\n`store`, `interface`, `refId`, `id`, `customerTags`, `attempt`, `createdAt`,\n`updatedAt`. There is **no `order_date` or amount/`total` filter here** — to sum or\nbreak down sales by **date, store or campaign**, use `order.report.sales`, not this\nlist.\n\n```\nGET /api/order/data?q[status][E]=completed\nGET /api/order/data?q[store][E]=207&q[client][E]=12345&e=20\n```"
                            },
                            "response": [
                                {
                                    "name": "Paginated list",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/data",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "data"
                                            ]
                                        },
                                        "description": "Returns a paginated list of orders, and **filters through the shared listing grammar**\n`q[column][operator]=value` - see [List query parameters](/docs/{lang}/guides/list-query-parameters)\nfor the full operator table.\n\n**Only these columns are filterable** (an unlisted column returns `400 Coluna nao\npermitida`): `status` (registered | completed | canceled), `orderStatus`, `client`,\n`store`, `interface`, `refId`, `id`, `customerTags`, `attempt`, `createdAt`,\n`updatedAt`. There is **no `order_date` or amount/`total` filter here** — to sum or\nbreak down sales by **date, store or campaign**, use `order.report.sales`, not this\nlist.\n\n```\nGET /api/order/data?q[status][E]=completed\nGET /api/order/data?q[store][E]=207&q[client][E]=12345&e=20\n```"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 121212,\n            \"refId\": \"ord-2026-001\",\n            \"status\": \"paid\",\n            \"total\": 19990,\n            \"createdAt\": \"2026-05-01T11:00:00-03:00\"\n        }\n    ],\n    \"total\": 1,\n    \"pagination\": { \"entries\": 20, \"currentPage\": 1, \"totalPages\": 1 }\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Orders (full)",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/data/full",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "data",
                                        "full"
                                    ]
                                },
                                "description": "Same listing as `GET /api/order/data` - same filters, ordering and pagination - but every\nrow carries the **complete order payload**, the same one `GET /api/order/data/{idOrder}`\nreturns: items, payments, campaigns, customer tags, history, reward, store and customer.\n\nUse it to read a whole page in detail without one request per order.\n\n```\nGET /api/order/data/full?q[status][E]=paid&e=20\n```\n\nCapped at 50 rows per page: each row carries its items, payments and history, so `e=0`\nwould mean the organization's whole history in one response. Anything above 50 - or `e=0` -\nis served as 50."
                            },
                            "response": [
                                {
                                    "name": "Paginated list, each row with the full order payload",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/data/full",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "data",
                                                "full"
                                            ]
                                        },
                                        "description": "Same listing as `GET /api/order/data` - same filters, ordering and pagination - but every\nrow carries the **complete order payload**, the same one `GET /api/order/data/{idOrder}`\nreturns: items, payments, campaigns, customer tags, history, reward, store and customer.\n\nUse it to read a whole page in detail without one request per order.\n\n```\nGET /api/order/data/full?q[status][E]=paid&e=20\n```\n\nCapped at 50 rows per page: each row carries its items, payments and history, so `e=0`\nwould mean the organization's whole history in one response. Anything above 50 - or `e=0` -\nis served as 50."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 1672118,\n            \"refId\": \"ord-2026-001\",\n            \"interface\": \"mystore\",\n            \"store\": {\n                \"id\": 124,\n                \"refId\": \"SP-01\",\n                \"name\": \"mystore\"\n            },\n            \"cashier\": \"6977\",\n            \"salesperson\": \"2367\",\n            \"client\": {\n                \"id\": 6497,\n                \"name\": \"Tintim\",\n                \"email\": \"tintim@tintim.com.br\",\n                \"countryCallingCode\": 55,\n                \"cellphone\": \"19966659986\",\n                \"document\": null\n            },\n            \"clientValidation\": null,\n            \"processStatus\": \"processed\",\n            \"orderStatus\": \"completed\",\n            \"paidValue\": 25000,\n            \"customerTag\": [\n                12,\n                34\n            ],\n            \"campaigns\": [\n                {\n                    \"campaign\": 656,\n                    \"value\": 2500,\n                    \"type\": \"monetary\"\n                }\n            ],\n            \"items\": [\n                {\n                    \"id\": 138876,\n                    \"productId\": null,\n                    \"productRefId\": \"9912\",\n                    \"productName\": \"Tenis Casual Feminino\",\n                    \"skuId\": null,\n                    \"skuRefId\": \"9912-34\",\n                    \"skuName\": \"Tenis Casual Feminino 34\",\n                    \"categoryId\": 659,\n                    \"brandId\": 987,\n                    \"quantity\": 1,\n                    \"quantityCanceled\": 0,\n                    \"price\": 25000,\n                    \"listPrice\": 26200,\n                    \"redemption\": 1200\n                }\n            ],\n            \"payments\": [\n                {\n                    \"id\": 55321,\n                    \"value\": 25000,\n                    \"type\": \"credit-card\",\n                    \"paymentSystem\": \"my-payment\",\n                    \"paymentSystemName\": \"My Payment\",\n                    \"installments\": 1,\n                    \"firstDigits\": \"4569\",\n                    \"lastDigits\": \"1236\"\n                }\n            ],\n            \"total_order\": 25000,\n            \"total_item\": 25000,\n            \"total_shipping\": 0,\n            \"total_taxes\": 0,\n            \"total_discounts\": 1200,\n            \"histories\": [\n                {\n                    \"status\": \"order-create\",\n                    \"reason\": \"Order Create\",\n                    \"date\": \"2026-09-01T10:35:00-03:00\"\n                }\n            ],\n            \"reward\": {\n                \"tid\": \"4fa1a7fa876a80ec025184e7786fd51f\",\n                \"rewardable\": 23800,\n                \"redeemable\": 0\n            },\n            \"createdAt\": \"2026-09-01T10:35:06-03:00\",\n            \"integratedAt\": \"2026-09-01T10:35:06-03:00\",\n            \"indexedAt\": \"2026-09-01T10:36:02-03:00\",\n            \"updatedAt\": \"2026-09-01T11:25:46-03:00\"\n        }\n    ],\n    \"total\": 348,\n    \"pagination\": {\n        \"entries\": 20,\n        \"order\": {\n            \"createdAt\": \"desc\"\n        },\n        \"totalPages\": 18,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": false,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 17\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get Order",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/data/{{idOrder}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "data",
                                        "{{idOrder}}"
                                    ]
                                },
                                "description": "Returns a single the order matching the given identifier."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/data/{{idOrder}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "data",
                                                "{{idOrder}}"
                                            ]
                                        },
                                        "description": "Returns a single the order matching the given identifier."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 1672118,\n    \"store\": {\n        \"id\": 124,\n        \"name\": \"mystore\"\n        },\n    \"cashier\": {\n            \"id\": 6977,\n            \"name\": \"Serafim Lampião\"\n        },\n    \"salesperson\": {\n            \"id\": 2367,\n            \"name\": \"Oliveira da Figueira\"\n        },\n    \"client\":  {\n            \"id\": 6497,\n            \"name\": \"Tintim\",\n            \"email\": \"tintim@tintim.com.br\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"19966659986\",\n            \"document\": null\n        },\n    \"orderStatus\": \"canceled\",\n    \"paidValue\": 0,\n    \"customerTag\": [],\n    \"items\": [\n        {\n            \"id\": \"138876\",\n            \"productId\": null,\n            \"name\": \"Tênis Casual Feminino 34\",\n            \"categoryId\": 659,    \n            \"brandId\": 987,\n            \"quantity\": 1,\n            \"price\": 25000,\n            \"listPrice\": 26200,\n            \"redemption\":  1200 \n            \n        }\n    ],\n    \"payments\": [\n        {\n            \"value\": 25000,\n            \"type\": \"promissory\",\n            \"paymentSystem\": \"my-payment\",\n            \"paymentSystemName\": \"My Payment\",\n            \"installments\": 1,\n            \"firstDigits\": \"4569\",\n            \"lastDigits\": \"1236\"\n        }\n    ],\n    \"total_order\": 25000,\n    \"total_item\": 25000,\n    \"total_shipping\": 0,\n    \"total_taxes\": 0,\n    \"total_discounts\": 1200,\n    \"histories\": [\n        {\n            \"status\": \"order-create\",\n            \"reason\": \"Order Create\",\n            \"date\": \"2024-09-27T07:35:00-03:00\"\n        }\n    ],\n    \"createdAt\": \"2024-09-27T10:35:06-03:00\",\n    \"integratedAt\": \"2024-09-27T10:35:06-03:00\",\n    \"indexedAt\": \"2024-09-27T10:36:02-03:00\",\n    \"updatedAt\": \"2024-12-02T11:25:46-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Using interface",
                            "item": [
                                {
                                    "name": "List Orders by Interface (full)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/{{interface}}/data/full",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "{{interface}}",
                                                "data",
                                                "full"
                                            ]
                                        },
                                        "description": "Same listing as `GET /api/order/{interface}/data`, with the complete order payload on every\nrow - the same one `GET /api/order/{interface}/data/{refId}` returns, already mapped to the\ninterface refIds (order, store, customer, products and payment systems).\n\nCapped at 50 rows per page."
                                    },
                                    "response": [
                                        {
                                            "name": "Paginated list, each row with the full order payload, mapped to the interface refIds",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/order/{{interface}}/data/full",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "order",
                                                        "{{interface}}",
                                                        "data",
                                                        "full"
                                                    ]
                                                },
                                                "description": "Same listing as `GET /api/order/{interface}/data`, with the complete order payload on every\nrow - the same one `GET /api/order/{interface}/data/{refId}` returns, already mapped to the\ninterface refIds (order, store, customer, products and payment systems).\n\nCapped at 50 rows per page."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        {\n            \"id\": \"ord-2026-001\",\n            \"interface\": \"mystore\",\n            \"store\": {\n                \"id\": \"SP-01\",\n                \"name\": \"mystore\"\n            },\n            \"cashier\": \"6977\",\n            \"salesperson\": \"2367\",\n            \"client\": {\n                \"id\": \"cli-8891\",\n                \"name\": \"Tintim\",\n                \"email\": \"tintim@tintim.com.br\",\n                \"countryCallingCode\": 55,\n                \"cellphone\": \"19966659986\",\n                \"document\": null\n            },\n            \"clientValidation\": null,\n            \"orderStatus\": \"completed\",\n            \"paidValue\": 25000,\n            \"customerTag\": [\n                12,\n                34\n            ],\n            \"items\": [\n                {\n                    \"id\": 138876,\n                    \"productId\": \"9912\",\n                    \"productName\": \"Tenis Casual Feminino\",\n                    \"skuId\": \"9912-34\",\n                    \"skuName\": \"Tenis Casual Feminino 34\",\n                    \"categoryId\": 659,\n                    \"brandId\": 987,\n                    \"quantity\": 1,\n                    \"quantityCanceled\": 0,\n                    \"price\": 25000,\n                    \"listPrice\": 26200,\n                    \"redemption\": 1200\n                }\n            ],\n            \"payments\": [\n                {\n                    \"value\": 25000,\n                    \"type\": \"credit-card\",\n                    \"paymentSystem\": \"my-payment\",\n                    \"paymentSystemName\": \"My Payment\",\n                    \"installments\": 1,\n                    \"firstDigits\": \"4569\",\n                    \"lastDigits\": \"1236\"\n                }\n            ],\n            \"total_order\": 25000,\n            \"total_item\": 25000,\n            \"total_shipping\": 0,\n            \"total_taxes\": 0,\n            \"total_discounts\": 1200,\n            \"histories\": [\n                {\n                    \"status\": \"order-create\",\n                    \"reason\": \"Order Create\",\n                    \"date\": \"2026-09-01T10:35:00-03:00\"\n                }\n            ],\n            \"reward\": {\n                \"tid\": \"4fa1a7fa876a80ec025184e7786fd51f\",\n                \"rewardable\": 23800,\n                \"redeemable\": 0\n            },\n            \"createdAt\": \"2026-09-01T10:35:06-03:00\",\n            \"integratedAt\": \"2026-09-01T10:35:06-03:00\",\n            \"indexedAt\": \"2026-09-01T10:36:02-03:00\",\n            \"updatedAt\": \"2026-09-01T11:25:46-03:00\"\n        }\n    ],\n    \"total\": 348,\n    \"pagination\": {\n        \"entries\": 20,\n        \"order\": {\n            \"createdAt\": \"desc\"\n        },\n        \"totalPages\": 18,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": false,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 17\n    }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Order by Interface",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/{{interface}}/data/{{idOrder}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "{{interface}}",
                                                "data",
                                                "{{idOrder}}"
                                            ]
                                        },
                                        "description": "Returns a single the order matching the given identifier."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/order/{{interface}}/data/{{idOrder}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "order",
                                                        "{{interface}}",
                                                        "data",
                                                        "{{idOrder}}"
                                                    ]
                                                },
                                                "description": "Returns a single the order matching the given identifier."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": \"303030308\",\n    \"store\": {\n        \"id\": \"365-66\",\n        \"name\": \"mystore\"\n        },\n    \"cashier\": {\n            \"name\": \"Serafim Lampião\"\n        },\n    \"salesperson\": {\n            \"name\": \"Oliveira da Figueira\"\n        },\n    \"client\":  {\n            \"id\": \"69657\",\n            \"name\": \"Tintim\",\n            \"email\": \"tintim@tintim.com.br\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"19966659986\",\n            \"document\": null\n        },\n    \"orderStatus\": \"canceled\",\n    \"paidValue\": 0,\n    \"customerTag\": [],\n    \"items\": [\n        {\n            \"id\": \"138876\",\n            \"productId\": null,\n            \"name\": \"Tênis Casual Feminino 34\",\n            \"categoryId\": \"210002\",    \n            \"brandId\": \"29300\",\n            \"quantity\": 1,\n            \"price\": 25000,\n            \"listPrice\": 26200,\n            \"redemption\":  1200 \n            \n        }\n    ],\n    \"payments\": [\n        {\n            \"value\": 25000,\n            \"type\": \"promissory\",\n            \"paymentSystem\": \"my-payment\",\n            \"paymentSystemName\": \"My Payment\",\n            \"installments\": 1,\n            \"firstDigits\": \"4569\",\n            \"lastDigits\": \"1236\"\n        }\n    ],\n    \"total_order\": 25000,\n    \"total_item\": 25000,\n    \"total_shipping\": 0,\n    \"total_taxes\": 0,\n    \"total_discounts\": 1200,\n    \"histories\": [\n        {\n            \"status\": \"order-create\",\n            \"reason\": \"Order Create\",\n            \"date\": \"2024-09-27T07:35:00-03:00\"\n        }\n    ],\n    \"createdAt\": \"2024-09-27T10:35:06-03:00\",\n    \"integratedAt\": \"2024-09-27T10:35:06-03:00\",\n    \"indexedAt\": \"2024-09-27T10:36:02-03:00\",\n    \"updatedAt\": \"2024-12-02T11:25:46-03:00\"\n}"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/order/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "order",
                                "ping"
                            ]
                        },
                        "description": "Returns `pong` to confirm the service is reachable."
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "ping"
                                    ]
                                },
                                "description": "Returns `pong` to confirm the service is reachable."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"organization\": \"acme\",\n    \"response\": \"Server online\",\n    \"dateTime\": \"2023-08-11T13:50:08-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Product",
                    "item": [
                        {
                            "name": "Search products by name",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/product/search",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "product",
                                        "search"
                                    ]
                                },
                                "description": "> **Superseded by `GET /api/register/event/search`** (register). The audience\n> builder now matches the product name directly via the generic `event` filter\n> (`type=buy_product`) — no name→SKU step. This endpoint still works, but the\n> `boughtSku` / `person_order_item` path is legacy (removed at cutover).\n\nResolves free-text product-name terms into the set of SKUs (`skuRefId`) that\nwere sold under matching names. Powers the **audience builder**: the matched\nSKUs feed the `boughtSku` audience filter in the register service.\n\n`terms` is free text — **whitespace-separated terms are ANDed** (accepts a\nspace-separated string `terms=a b` or repeated `terms[]=a&terms[]=b`).\n`sandalia salto` returns only SKUs whose product name contains *both* words\n(same name string). Matching is case- and accent-insensitive (collation\n`utf8mb4_general_ci`), so `tenis` matches `TÊNIS`.\n\nThe product name comes from `order_item.productName` (a per-line snapshot —\nGuper has no separate product catalog). Results are grouped by `skuRefId`;\neach entry returns a representative `name` and the matched-line count\n(`hits`), ordered by `hits` desc. There is **no `interface` scoping** —\n`skuRefId` is the organization's canonical SKU reference.\n\nAuth: service-to-service RSA `signature` (see *Internal › Integração ›\nSignature*). Organization is taken from the request context.\n\n### Worked example\n\n**1. Search** — find the SKUs named \"sandalia salto\":\n\n```\nGET /api/order/product/search?terms=sandalia%20salto\n```\n```json\n{\n    \"terms\": [\"sandalia\", \"salto\"],\n    \"total\": 1,\n    \"products\": [\n        { \"sku\": \"47142\", \"name\": \"Sandalia Salto Alto 38\", \"hits\": 14 }\n    ]\n}\n```\n\n**2. Build the audience** — feed the returned `sku` values into the register\naudience query as a `boughtSku` filter (here: bought it in the last 3 months):\n\n```json\n[\n    [\"boughtSku\", \"in\", { \"list\": [\"47142\"] }, { \"int\": 3 }]\n]\n```\n\nCombine with other filters via `AND` — e.g. men who bought it: prepend\n`[\"gender\",\"equals\",{\"string\":\"male\"}], \"AND\",`. See *Internal › Services ›\nRegister › Audiência por produto* for the full `boughtSku` reference."
                            },
                            "response": [
                                {
                                    "name": "Matched SKUs grouped by `skuRefId`, ordered by `hits` desc.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/product/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "product",
                                                "search"
                                            ]
                                        },
                                        "description": "> **Superseded by `GET /api/register/event/search`** (register). The audience\n> builder now matches the product name directly via the generic `event` filter\n> (`type=buy_product`) — no name→SKU step. This endpoint still works, but the\n> `boughtSku` / `person_order_item` path is legacy (removed at cutover).\n\nResolves free-text product-name terms into the set of SKUs (`skuRefId`) that\nwere sold under matching names. Powers the **audience builder**: the matched\nSKUs feed the `boughtSku` audience filter in the register service.\n\n`terms` is free text — **whitespace-separated terms are ANDed** (accepts a\nspace-separated string `terms=a b` or repeated `terms[]=a&terms[]=b`).\n`sandalia salto` returns only SKUs whose product name contains *both* words\n(same name string). Matching is case- and accent-insensitive (collation\n`utf8mb4_general_ci`), so `tenis` matches `TÊNIS`.\n\nThe product name comes from `order_item.productName` (a per-line snapshot —\nGuper has no separate product catalog). Results are grouped by `skuRefId`;\neach entry returns a representative `name` and the matched-line count\n(`hits`), ordered by `hits` desc. There is **no `interface` scoping** —\n`skuRefId` is the organization's canonical SKU reference.\n\nAuth: service-to-service RSA `signature` (see *Internal › Integração ›\nSignature*). Organization is taken from the request context.\n\n### Worked example\n\n**1. Search** — find the SKUs named \"sandalia salto\":\n\n```\nGET /api/order/product/search?terms=sandalia%20salto\n```\n```json\n{\n    \"terms\": [\"sandalia\", \"salto\"],\n    \"total\": 1,\n    \"products\": [\n        { \"sku\": \"47142\", \"name\": \"Sandalia Salto Alto 38\", \"hits\": 14 }\n    ]\n}\n```\n\n**2. Build the audience** — feed the returned `sku` values into the register\naudience query as a `boughtSku` filter (here: bought it in the last 3 months):\n\n```json\n[\n    [\"boughtSku\", \"in\", { \"list\": [\"47142\"] }, { \"int\": 3 }]\n]\n```\n\nCombine with other filters via `AND` — e.g. men who bought it: prepend\n`[\"gender\",\"equals\",{\"string\":\"male\"}], \"AND\",`. See *Internal › Services ›\nRegister › Audiência por produto* for the full `boughtSku` reference."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"terms\": [\"sandalia\", \"salto\"],\n    \"total\": 1,\n    \"products\": [\n        { \"sku\": \"47142\", \"name\": \"Sandalia Salto Alto 38\", \"hits\": 14 }\n    ]\n}"
                                },
                                {
                                    "name": "No terms supplied (`terms` empty) — empty result.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/product/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "product",
                                                "search"
                                            ]
                                        },
                                        "description": "> **Superseded by `GET /api/register/event/search`** (register). The audience\n> builder now matches the product name directly via the generic `event` filter\n> (`type=buy_product`) — no name→SKU step. This endpoint still works, but the\n> `boughtSku` / `person_order_item` path is legacy (removed at cutover).\n\nResolves free-text product-name terms into the set of SKUs (`skuRefId`) that\nwere sold under matching names. Powers the **audience builder**: the matched\nSKUs feed the `boughtSku` audience filter in the register service.\n\n`terms` is free text — **whitespace-separated terms are ANDed** (accepts a\nspace-separated string `terms=a b` or repeated `terms[]=a&terms[]=b`).\n`sandalia salto` returns only SKUs whose product name contains *both* words\n(same name string). Matching is case- and accent-insensitive (collation\n`utf8mb4_general_ci`), so `tenis` matches `TÊNIS`.\n\nThe product name comes from `order_item.productName` (a per-line snapshot —\nGuper has no separate product catalog). Results are grouped by `skuRefId`;\neach entry returns a representative `name` and the matched-line count\n(`hits`), ordered by `hits` desc. There is **no `interface` scoping** —\n`skuRefId` is the organization's canonical SKU reference.\n\nAuth: service-to-service RSA `signature` (see *Internal › Integração ›\nSignature*). Organization is taken from the request context.\n\n### Worked example\n\n**1. Search** — find the SKUs named \"sandalia salto\":\n\n```\nGET /api/order/product/search?terms=sandalia%20salto\n```\n```json\n{\n    \"terms\": [\"sandalia\", \"salto\"],\n    \"total\": 1,\n    \"products\": [\n        { \"sku\": \"47142\", \"name\": \"Sandalia Salto Alto 38\", \"hits\": 14 }\n    ]\n}\n```\n\n**2. Build the audience** — feed the returned `sku` values into the register\naudience query as a `boughtSku` filter (here: bought it in the last 3 months):\n\n```json\n[\n    [\"boughtSku\", \"in\", { \"list\": [\"47142\"] }, { \"int\": 3 }]\n]\n```\n\nCombine with other filters via `AND` — e.g. men who bought it: prepend\n`[\"gender\",\"equals\",{\"string\":\"male\"}], \"AND\",`. See *Internal › Services ›\nRegister › Audiência por produto* for the full `boughtSku` reference."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"terms\": [], \"total\": 0, \"products\": [] }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Report",
                    "item": [
                        {
                            "name": "Audience by product — how many clients bought a product or category",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/report/by-product/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "report",
                                        "by-product",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Clients who **bought a given product** in a window — matched by product name\npattern or SKU — the audience the QON builder can't express, because it has no\nitem, SKU, category or brand column at all. Answers \"who bought luggage over\n$500 this semester\", \"buyers of these SKUs\", in a **single call** instead of\npaging hundreds of thousands of line items and grouping client-side.\n\nMatch by `productNameLike` (a list of patterns, **OR** between them, **case- and\naccent-insensitive**, contains) and/or `skuRefId` (exact). At least one is\nrequired. Narrow by unit price (`unitPriceMin`/`unitPriceMax`) and by pieces\n(`minQuantity`, net of cancellation).\n\n**`price` is the unit price, net of discount** — so `unitPriceMin`/`Max` filter\nthe **unit** directly, not `price/quantity`. This is what separates a real\nproduct from a 1-cent promo gift in the same family. `value` is\n`SUM(price × net quantity)` — money spent on the matching items, in **cents**.\n\nPer row: `pieces` (net quantity bought), `value`, `lastDate`, and\n**`matchedPatterns`** — which of your `productNameLike` patterns the client hit,\nso you can show **why** each one is in the audience. The window and `lastDate`\nare in the **org timezone**. Rows are paginated (`e`/`p`); `total` is the full\naudience size.\n\n**This is the order side only — `client` id + metrics.** Name, email, phone,\nlast store and store group live in **register**; so do the \"exclude these lists\"\nand \"must have contact\" filters. Enrich and filter with the register operations,\nand close the loop with `register.audience-list.person.create` (which takes the\nclient ids).\n\n**Name matching inherits the POS naming mess.** `category`/`categoryRefId` come\nin empty or inconsistent on some orgs (Cloe included), so name is the reliable\nkey today — but it carries legacy spellings and external-ref patterns. Widen\n`productNameLike` when in doubt, and read `matchedPatterns` to see what actually\ncaught."
                            },
                            "response": [
                                {
                                    "name": "OK — luggage buyers, unit over $500",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/by-product/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "by-product",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Clients who **bought a given product** in a window — matched by product name\npattern or SKU — the audience the QON builder can't express, because it has no\nitem, SKU, category or brand column at all. Answers \"who bought luggage over\n$500 this semester\", \"buyers of these SKUs\", in a **single call** instead of\npaging hundreds of thousands of line items and grouping client-side.\n\nMatch by `productNameLike` (a list of patterns, **OR** between them, **case- and\naccent-insensitive**, contains) and/or `skuRefId` (exact). At least one is\nrequired. Narrow by unit price (`unitPriceMin`/`unitPriceMax`) and by pieces\n(`minQuantity`, net of cancellation).\n\n**`price` is the unit price, net of discount** — so `unitPriceMin`/`Max` filter\nthe **unit** directly, not `price/quantity`. This is what separates a real\nproduct from a 1-cent promo gift in the same family. `value` is\n`SUM(price × net quantity)` — money spent on the matching items, in **cents**.\n\nPer row: `pieces` (net quantity bought), `value`, `lastDate`, and\n**`matchedPatterns`** — which of your `productNameLike` patterns the client hit,\nso you can show **why** each one is in the audience. The window and `lastDate`\nare in the **org timezone**. Rows are paginated (`e`/`p`); `total` is the full\naudience size.\n\n**This is the order side only — `client` id + metrics.** Name, email, phone,\nlast store and store group live in **register**; so do the \"exclude these lists\"\nand \"must have contact\" filters. Enrich and filter with the register operations,\nand close the loop with `register.audience-list.person.create` (which takes the\nclient ids).\n\n**Name matching inherits the POS naming mess.** `category`/`categoryRefId` come\nin empty or inconsistent on some orgs (Cloe included), so name is the reliable\nkey today — but it carries legacy spellings and external-ref patterns. Widen\n`productNameLike` when in doubt, and read `matchedPatterns` to see what actually\ncaught."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"cents\", \"timezone\": \"America/Mexico_City\",\n    \"filters\": {\n      \"productNameLike\": [\"EQUIPAJE VERTICAL\",\"EQUIPAJE VIAJE\",\"SET DE VIAJE\",\"MALETA\"],\n      \"skuRefId\": [], \"unitPriceMin\": 50000, \"unitPriceMax\": null,\n      \"minQuantity\": 1, \"status\": \"completed\"\n    }\n  },\n  \"rows\": [\n    { \"client\": 4134488, \"pieces\": 5, \"value\": 958795715, \"lastDate\": \"2026-06-01\",\n      \"matchedPatterns\": [\"EQUIPAJE VERTICAL\",\"EQUIPAJE VIAJE\",\"SET DE VIAJE\"] }\n  ],\n  \"total\": 4624,\n  \"pagination\": { \"entries\": 100, \"currentPage\": 1, \"totalPages\": 47, \"isInitial\": true, \"isEnd\": false }\n}"
                                },
                                {
                                    "name": "Neither productNameLike nor skuRefId given, invalid `status`, unitPriceMin > unitPriceMax, or dateStart after dateEnd.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/by-product/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "by-product",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Clients who **bought a given product** in a window — matched by product name\npattern or SKU — the audience the QON builder can't express, because it has no\nitem, SKU, category or brand column at all. Answers \"who bought luggage over\n$500 this semester\", \"buyers of these SKUs\", in a **single call** instead of\npaging hundreds of thousands of line items and grouping client-side.\n\nMatch by `productNameLike` (a list of patterns, **OR** between them, **case- and\naccent-insensitive**, contains) and/or `skuRefId` (exact). At least one is\nrequired. Narrow by unit price (`unitPriceMin`/`unitPriceMax`) and by pieces\n(`minQuantity`, net of cancellation).\n\n**`price` is the unit price, net of discount** — so `unitPriceMin`/`Max` filter\nthe **unit** directly, not `price/quantity`. This is what separates a real\nproduct from a 1-cent promo gift in the same family. `value` is\n`SUM(price × net quantity)` — money spent on the matching items, in **cents**.\n\nPer row: `pieces` (net quantity bought), `value`, `lastDate`, and\n**`matchedPatterns`** — which of your `productNameLike` patterns the client hit,\nso you can show **why** each one is in the audience. The window and `lastDate`\nare in the **org timezone**. Rows are paginated (`e`/`p`); `total` is the full\naudience size.\n\n**This is the order side only — `client` id + metrics.** Name, email, phone,\nlast store and store group live in **register**; so do the \"exclude these lists\"\nand \"must have contact\" filters. Enrich and filter with the register operations,\nand close the loop with `register.audience-list.person.create` (which takes the\nclient ids).\n\n**Name matching inherits the POS naming mess.** `category`/`categoryRefId` come\nin empty or inconsistent on some orgs (Cloe included), so name is the reliable\nkey today — but it carries legacy spellings and external-ref patterns. Widen\n`productNameLike` when in doubt, and read `matchedPatterns` to see what actually\ncaught."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Top products sold",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/report/products/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "report",
                                        "products",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "The answer to \"what sold most\", \"top products by revenue\", \"units per SKU\",\nin a **single call** — instead of paging line items and grouping client-side.\nRanks sold items (`order_item`) by product, SKU, category or brand, in the\n**same scope as the sales report** (org, window in the org timezone, store,\nstatus).\n\nPer row: `units` (quantity sold), `unitsCanceled`, `revenue`, `orders` (how\nmany orders included it) and `lines`. Rows are the **top N by revenue**\n(`limit`, default 50); the `total` covers **every** item in the period, not\njust the top.\n\n**Break it down by store or time in one call.** `groupBy` takes a comma list:\nthe first token is the item dimension (`product`/`sku`/`category`/`brand`) and\nyou may add `store` and/or one time grain (`day`/`week`/`month`) — e.g.\n`groupBy=product,store`, `sku,week`, `product,store,month`. With a breakdown the\n`limit` picks the **top items for the whole period** and each row is one cell\n(item × store × period), so you get the per-store or weekly split without one\ncall per store. Each row then carries `storeId`, `day` (YYYY-MM-DD), `week`\n(YYYY-Www, ISO) or `month` (YYYY-MM) as applicable; a cell with no sales is not\nemitted.\n\n**`revenue` is line revenue** — `SUM(price × quantity)`, where `price` is the\nitem's unit price net of the item discount. It is **not** the order total, and\ndoes **not** match the sales report's revenue: order-level discounts and\nadjustments are not pushed down to the item price, so the sum of the lines runs\nhigher (≈+20% measured). Use this for **product ranking**; use\n`order.report.sales` for revenue/billing. Values are in **cents**.\n\n`category` and `brand` come from **partial ingestion** and are sparse today\n(single-digit % on some orgs). The endpoint is ready for them now and fills in\nas ingestion improves — read `meta.coverage` (the fraction of items and revenue\nthat carry a category/brand) so a breakdown covering 5% of the period is not\nmistaken for the whole. Rows with a null id are the items missing that field.\n`order_item` stores no category/brand **name**, only the id and external refId."
                            },
                            "response": [
                                {
                                    "name": "OK — with `groupBy=product`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/products/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "products",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "The answer to \"what sold most\", \"top products by revenue\", \"units per SKU\",\nin a **single call** — instead of paging line items and grouping client-side.\nRanks sold items (`order_item`) by product, SKU, category or brand, in the\n**same scope as the sales report** (org, window in the org timezone, store,\nstatus).\n\nPer row: `units` (quantity sold), `unitsCanceled`, `revenue`, `orders` (how\nmany orders included it) and `lines`. Rows are the **top N by revenue**\n(`limit`, default 50); the `total` covers **every** item in the period, not\njust the top.\n\n**Break it down by store or time in one call.** `groupBy` takes a comma list:\nthe first token is the item dimension (`product`/`sku`/`category`/`brand`) and\nyou may add `store` and/or one time grain (`day`/`week`/`month`) — e.g.\n`groupBy=product,store`, `sku,week`, `product,store,month`. With a breakdown the\n`limit` picks the **top items for the whole period** and each row is one cell\n(item × store × period), so you get the per-store or weekly split without one\ncall per store. Each row then carries `storeId`, `day` (YYYY-MM-DD), `week`\n(YYYY-Www, ISO) or `month` (YYYY-MM) as applicable; a cell with no sales is not\nemitted.\n\n**`revenue` is line revenue** — `SUM(price × quantity)`, where `price` is the\nitem's unit price net of the item discount. It is **not** the order total, and\ndoes **not** match the sales report's revenue: order-level discounts and\nadjustments are not pushed down to the item price, so the sum of the lines runs\nhigher (≈+20% measured). Use this for **product ranking**; use\n`order.report.sales` for revenue/billing. Values are in **cents**.\n\n`category` and `brand` come from **partial ingestion** and are sparse today\n(single-digit % on some orgs). The endpoint is ready for them now and fills in\nas ingestion improves — read `meta.coverage` (the fraction of items and revenue\nthat carry a category/brand) so a breakdown covering 5% of the period is not\nmistaken for the whole. Rows with a null id are the items missing that field.\n`order_item` stores no category/brand **name**, only the id and external refId."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"cents\", \"timezone\": \"Etc/GMT+6\",\n    \"groupBy\": \"product\", \"breakdown\": [], \"limit\": 50,\n    \"filters\": { \"store\": null, \"status\": \"all except canceled (default)\" },\n    \"coverage\": {\n      \"category\": { \"items\": 0.049, \"revenue\": 0.065 },\n      \"brand\":    { \"items\": 0.049, \"revenue\": 0.061 }\n    }\n  },\n  \"rows\": [\n    { \"productId\": 0, \"productName\": \"I-2 BILLETERA CLOE P25 564 ROSA /FLAP GR\",\n      \"units\": 256, \"unitsCanceled\": 0, \"revenue\": 122482432, \"orders\": 115, \"lines\": 121 }\n  ],\n  \"total\": { \"units\": 60663, \"unitsCanceled\": 0, \"revenue\": 6124205576, \"orders\": 24815, \"lines\": 56403 }\n}"
                                },
                                {
                                    "name": "Invalid `groupBy` (unknown dimension/breakdown, or more than one time grain), invalid `status`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/products/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "products",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "The answer to \"what sold most\", \"top products by revenue\", \"units per SKU\",\nin a **single call** — instead of paging line items and grouping client-side.\nRanks sold items (`order_item`) by product, SKU, category or brand, in the\n**same scope as the sales report** (org, window in the org timezone, store,\nstatus).\n\nPer row: `units` (quantity sold), `unitsCanceled`, `revenue`, `orders` (how\nmany orders included it) and `lines`. Rows are the **top N by revenue**\n(`limit`, default 50); the `total` covers **every** item in the period, not\njust the top.\n\n**Break it down by store or time in one call.** `groupBy` takes a comma list:\nthe first token is the item dimension (`product`/`sku`/`category`/`brand`) and\nyou may add `store` and/or one time grain (`day`/`week`/`month`) — e.g.\n`groupBy=product,store`, `sku,week`, `product,store,month`. With a breakdown the\n`limit` picks the **top items for the whole period** and each row is one cell\n(item × store × period), so you get the per-store or weekly split without one\ncall per store. Each row then carries `storeId`, `day` (YYYY-MM-DD), `week`\n(YYYY-Www, ISO) or `month` (YYYY-MM) as applicable; a cell with no sales is not\nemitted.\n\n**`revenue` is line revenue** — `SUM(price × quantity)`, where `price` is the\nitem's unit price net of the item discount. It is **not** the order total, and\ndoes **not** match the sales report's revenue: order-level discounts and\nadjustments are not pushed down to the item price, so the sum of the lines runs\nhigher (≈+20% measured). Use this for **product ranking**; use\n`order.report.sales` for revenue/billing. Values are in **cents**.\n\n`category` and `brand` come from **partial ingestion** and are sparse today\n(single-digit % on some orgs). The endpoint is ready for them now and fills in\nas ingestion improves — read `meta.coverage` (the fraction of items and revenue\nthat carry a category/brand) so a breakdown covering 5% of the period is not\nmistaken for the whole. Rows with a null id are the items missing that field.\n`order_item` stores no category/brand **name**, only the id and external refId."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Audience by purchase frequency",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/report/purchase-frequency/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "report",
                                        "purchase-frequency",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Clients who bought **N times in a window**, with an optional **value floor per\npurchase** — the audience the QON builder can't express, because its RFM is\n**lifetime** (no window) and has no notion of a purchase *day*. Answers \"who\nbought 3+ times over $X this semester\", \"high-value repeat buyers\", \"spent more\nthan $Y since January\", in a **single call** instead of paging orders and\naggregating client-side.\n\nAn **occurrence** is an order (`groupBy=order`) or a **purchase day**\n(`groupBy=purchase_day`), where the tickets of the same day are **summed** —\nretail splits one purchase across several tickets, so the day, not the order, is\nthe unit the campaign means. On Cloe's 2026 this is 14% of the audience.\n\n`valueMode` sets the floor: `all` = **every** occurrence ≥ `valueMin` (recurring\nhigh value); `any` = at least one; `sum` = the window total. `valueMin` is in\n**cents**, inclusive. `minOccurrences` is the minimum count of orders/days.\n\nPer row: `occurrences` (count), `value` (window total), `minValue`/`maxValue`\n(smallest/largest occurrence) and `lastDate` — the diagnostics that let you show\n**why** each client qualified. Values are in **cents**; the window and the day\nare cut from `order_date` in the **org timezone**, like the sales report. Rows\nare paginated (`e`/`p`); `total` is the full audience size.\n\n**This is the order side only — `client` id + metrics.** Name, email, phone,\nlast store and store group live in **register**; so do the \"exclude these\nexperiment lists\" and \"must have contact\" filters. Enrich and filter with the\nregister operations, and close the loop with\n`register.audience-list.person.create` (which takes the client ids) — no CSV in\nthe middle."
                            },
                            "response": [
                                {
                                    "name": "OK — `groupBy=purchase_day`, `minOccurrences=2`, `valueMin=300000`, `valueMode=all`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/purchase-frequency/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "purchase-frequency",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Clients who bought **N times in a window**, with an optional **value floor per\npurchase** — the audience the QON builder can't express, because its RFM is\n**lifetime** (no window) and has no notion of a purchase *day*. Answers \"who\nbought 3+ times over $X this semester\", \"high-value repeat buyers\", \"spent more\nthan $Y since January\", in a **single call** instead of paging orders and\naggregating client-side.\n\nAn **occurrence** is an order (`groupBy=order`) or a **purchase day**\n(`groupBy=purchase_day`), where the tickets of the same day are **summed** —\nretail splits one purchase across several tickets, so the day, not the order, is\nthe unit the campaign means. On Cloe's 2026 this is 14% of the audience.\n\n`valueMode` sets the floor: `all` = **every** occurrence ≥ `valueMin` (recurring\nhigh value); `any` = at least one; `sum` = the window total. `valueMin` is in\n**cents**, inclusive. `minOccurrences` is the minimum count of orders/days.\n\nPer row: `occurrences` (count), `value` (window total), `minValue`/`maxValue`\n(smallest/largest occurrence) and `lastDate` — the diagnostics that let you show\n**why** each client qualified. Values are in **cents**; the window and the day\nare cut from `order_date` in the **org timezone**, like the sales report. Rows\nare paginated (`e`/`p`); `total` is the full audience size.\n\n**This is the order side only — `client` id + metrics.** Name, email, phone,\nlast store and store group live in **register**; so do the \"exclude these\nexperiment lists\" and \"must have contact\" filters. Enrich and filter with the\nregister operations, and close the loop with\n`register.audience-list.person.create` (which takes the client ids) — no CSV in\nthe middle."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"cents\", \"timezone\": \"America/Mexico_City\",\n    \"groupBy\": \"purchase_day\",\n    \"filters\": { \"minOccurrences\": 2, \"valueMin\": 300000, \"valueMode\": \"all\", \"status\": \"completed\" },\n    \"notes\": { \"occurrence\": \"...\", \"valueMode\": \"...\", \"scope\": \"...\" }\n  },\n  \"rows\": [\n    { \"client\": 363050, \"occurrences\": 11, \"value\": 546004833,\n      \"minValue\": 2512579, \"maxValue\": 166735504, \"lastDate\": \"2026-08-25\" }\n  ],\n  \"total\": 1339,\n  \"pagination\": { \"entries\": 100, \"currentPage\": 1, \"totalPages\": 14, \"isInitial\": true, \"isEnd\": false }\n}"
                                },
                                {
                                    "name": "Invalid `groupBy`, `valueMode` or `status`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/purchase-frequency/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "purchase-frequency",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Clients who bought **N times in a window**, with an optional **value floor per\npurchase** — the audience the QON builder can't express, because its RFM is\n**lifetime** (no window) and has no notion of a purchase *day*. Answers \"who\nbought 3+ times over $X this semester\", \"high-value repeat buyers\", \"spent more\nthan $Y since January\", in a **single call** instead of paging orders and\naggregating client-side.\n\nAn **occurrence** is an order (`groupBy=order`) or a **purchase day**\n(`groupBy=purchase_day`), where the tickets of the same day are **summed** —\nretail splits one purchase across several tickets, so the day, not the order, is\nthe unit the campaign means. On Cloe's 2026 this is 14% of the audience.\n\n`valueMode` sets the floor: `all` = **every** occurrence ≥ `valueMin` (recurring\nhigh value); `any` = at least one; `sum` = the window total. `valueMin` is in\n**cents**, inclusive. `minOccurrences` is the minimum count of orders/days.\n\nPer row: `occurrences` (count), `value` (window total), `minValue`/`maxValue`\n(smallest/largest occurrence) and `lastDate` — the diagnostics that let you show\n**why** each client qualified. Values are in **cents**; the window and the day\nare cut from `order_date` in the **org timezone**, like the sales report. Rows\nare paginated (`e`/`p`); `total` is the full audience size.\n\n**This is the order side only — `client` id + metrics.** Name, email, phone,\nlast store and store group live in **register**; so do the \"exclude these\nexperiment lists\" and \"must have contact\" filters. Enrich and filter with the\nregister operations, and close the loop with\n`register.audience-list.person.create` (which takes the client ids) — no CSV in\nthe middle."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Sales & revenue report: by day/store, dashboard, campaign attribution",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/order/report/sales/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "order",
                                        "report",
                                        "sales",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Aggregated sales/revenue for a period, broken down by day, month, store or\nintegration channel (`interface`) — the answer to \"how much did I sell\nyesterday\", \"revenue by store this month\", \"sales per channel\", \"average\nticket per period\". Returns totals plus a per-status breakdown; each row/total\ncarries `revenue` and `discounts`. Filter to a cohort with `client`.\n\n**Revenue is net of cancellations by default** (canceled orders are excluded\nfrom the total). The `byStatus` block always reports every status, including\ncanceled, so what was left out stays auditable.\n\nEvery total carries **`mix`**, the revenue broken down from list price to what\nactually came in — the answer to \"what is my net revenue\", \"how much did I\ngive away in discount\", \"what did the loyalty program cost me\":\n\n| field | meaning |\n|---|---|\n| `listRevenue` | list price — `revenue + discounts` |\n| `discount` | what the store gave up |\n| `incentive` | balance the program paid (`null` without `withAttribution`) |\n| `netRevenue` | what came in — `revenue − incentive` (`null` without `withAttribution`) |\n| `averageTicket` | **ASP**, the average price actually charged |\n| `listAverageTicket` | **OSP**, the average list price, before discount |\n\n⚠️ **`revenue` is already net of the commercial discount** — an item's `price`\nis the unit price after discount. So list price is `revenue` **plus**\n`discounts`, not minus. Subtracting the discount from `revenue` counts it\ntwice, and it is the most common way to get this number wrong.\n\n⚠️ Do **not** confuse `mix` with `attribution.revenueGross` / `revenueNet`:\nthose are scoped to the attributed orders only, while `mix` is the whole\nbusiness.\n\n⚠️ `listRevenue` and `listAverageTicket` are only as good as `total_discounts`.\nWhere the integration does not send \"list price minus sale price\" the number\ndoes not hold — `ordersDiscountOverRevenue`, in the same total, counts the\norders whose discount is bigger than the sale itself.\n\nEvery total and row also carries the headline counts: **`orders`**, **`revenue`**,\n**`averageTicket`**, and **`customersIdentified`** — the number of **unique\nbuyers** (distinct customers, `COUNT(DISTINCT client)`): how many different\npeople bought — plus **`ordersIdentified`** / **`ordersAnonymous`** (orders with\nvs. without an identified customer). So \"sales by day with average ticket and\nunique buyers\" is a single call: this report with `groupBy=day` (add\n`membership=member` for members only). `customersIdentified` counts identified\nbuyers only — an anonymous order has no customer to count.\n\nPass **`compareWith`** to get a period-over-period comparison: the response\nadds a `comparison` block with the baseline period's total and the `delta`\n(absolute and percent) on orders, revenue and average ticket — so you can\nanswer \"sold X, +12% vs last month\".\n\nPass **`withAttribution`** for revenue **attributed to campaigns** — the total\nvalue of the **sales where a campaign's cashback / balance was redeemed** or\nwhose message drove the purchase, and the same broken down **per campaign**\n(`topCampaigns=N`), so you can answer \"how much did campaign X's cashback\ngenerate\" and the **ticket per campaign**. This is influenced revenue, not\nincremental. The block also splits **attributed** sales (balance redeemed),\n**influenced** ones (only got the message and bought) and the **impacted**\ntotal (the sum) in `split`. Within the attributed sales, `split` also separates\n**cashback** (redeemed, no push) from **push** (redeemed *and* a push\nnotification — push wins the tie), so you can read the push-assisted revenue\napart from organic cashback; `cashback + push = attributed`. The split is in\n`byDay` and in the `byStore`/`byInterface` breakdowns too (cashback vs push by\nchannel and month).\n\nValues are in **cents**. The day is cut from `order_date` (the business date)\nconverted to the organization timezone, so a sale rings up on the day it\nhappened, not the day it synced. `updatedThrough` is the newest `createAt`\nthat entered the calculation — because orders arrive after the sale,\n\"yesterday\" is a moving number; use it to decide whether to refetch.\n\nSupersedes `financeSumary`, which summed cancellations, dropped the last day\nof the period and grouped in UTC."
                            },
                            "response": [
                                {
                                    "name": "OK — with `compareWith=previous&groupBy=month`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/sales/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "sales",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Aggregated sales/revenue for a period, broken down by day, month, store or\nintegration channel (`interface`) — the answer to \"how much did I sell\nyesterday\", \"revenue by store this month\", \"sales per channel\", \"average\nticket per period\". Returns totals plus a per-status breakdown; each row/total\ncarries `revenue` and `discounts`. Filter to a cohort with `client`.\n\n**Revenue is net of cancellations by default** (canceled orders are excluded\nfrom the total). The `byStatus` block always reports every status, including\ncanceled, so what was left out stays auditable.\n\nEvery total carries **`mix`**, the revenue broken down from list price to what\nactually came in — the answer to \"what is my net revenue\", \"how much did I\ngive away in discount\", \"what did the loyalty program cost me\":\n\n| field | meaning |\n|---|---|\n| `listRevenue` | list price — `revenue + discounts` |\n| `discount` | what the store gave up |\n| `incentive` | balance the program paid (`null` without `withAttribution`) |\n| `netRevenue` | what came in — `revenue − incentive` (`null` without `withAttribution`) |\n| `averageTicket` | **ASP**, the average price actually charged |\n| `listAverageTicket` | **OSP**, the average list price, before discount |\n\n⚠️ **`revenue` is already net of the commercial discount** — an item's `price`\nis the unit price after discount. So list price is `revenue` **plus**\n`discounts`, not minus. Subtracting the discount from `revenue` counts it\ntwice, and it is the most common way to get this number wrong.\n\n⚠️ Do **not** confuse `mix` with `attribution.revenueGross` / `revenueNet`:\nthose are scoped to the attributed orders only, while `mix` is the whole\nbusiness.\n\n⚠️ `listRevenue` and `listAverageTicket` are only as good as `total_discounts`.\nWhere the integration does not send \"list price minus sale price\" the number\ndoes not hold — `ordersDiscountOverRevenue`, in the same total, counts the\norders whose discount is bigger than the sale itself.\n\nEvery total and row also carries the headline counts: **`orders`**, **`revenue`**,\n**`averageTicket`**, and **`customersIdentified`** — the number of **unique\nbuyers** (distinct customers, `COUNT(DISTINCT client)`): how many different\npeople bought — plus **`ordersIdentified`** / **`ordersAnonymous`** (orders with\nvs. without an identified customer). So \"sales by day with average ticket and\nunique buyers\" is a single call: this report with `groupBy=day` (add\n`membership=member` for members only). `customersIdentified` counts identified\nbuyers only — an anonymous order has no customer to count.\n\nPass **`compareWith`** to get a period-over-period comparison: the response\nadds a `comparison` block with the baseline period's total and the `delta`\n(absolute and percent) on orders, revenue and average ticket — so you can\nanswer \"sold X, +12% vs last month\".\n\nPass **`withAttribution`** for revenue **attributed to campaigns** — the total\nvalue of the **sales where a campaign's cashback / balance was redeemed** or\nwhose message drove the purchase, and the same broken down **per campaign**\n(`topCampaigns=N`), so you can answer \"how much did campaign X's cashback\ngenerate\" and the **ticket per campaign**. This is influenced revenue, not\nincremental. The block also splits **attributed** sales (balance redeemed),\n**influenced** ones (only got the message and bought) and the **impacted**\ntotal (the sum) in `split`. Within the attributed sales, `split` also separates\n**cashback** (redeemed, no push) from **push** (redeemed *and* a push\nnotification — push wins the tie), so you can read the push-assisted revenue\napart from organic cashback; `cashback + push = attributed`. The split is in\n`byDay` and in the `byStore`/`byInterface` breakdowns too (cashback vs push by\nchannel and month).\n\nValues are in **cents**. The day is cut from `order_date` (the business date)\nconverted to the organization timezone, so a sale rings up on the day it\nhappened, not the day it synced. `updatedThrough` is the newest `createAt`\nthat entered the calculation — because orders arrive after the sale,\n\"yesterday\" is a moving number; use it to decide whether to refetch.\n\nSupersedes `financeSumary`, which summed cancellations, dropped the last day\nof the period and grouped in UTC."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"cents\",\n    \"timezone\": \"America/Sao_Paulo\",\n    \"groupBy\": [\"month\"],\n    \"filters\": { \"store\": null, \"status\": \"all except canceled (default)\" }\n  },\n  \"rows\": [\n    { \"month\": \"2026-08\", \"orders\": 22431, \"revenue\": 4936614695,\n      \"discounts\": 261093017, \"averageTicket\": 220080, \"customersIdentified\": 13445,\n      \"ordersIdentified\": 22283, \"ordersAnonymous\": 148 }\n  ],\n  \"total\": {\n    \"orders\": 22431, \"revenue\": 4936614695, \"discounts\": 261093017, \"averageTicket\": 220080,\n    \"customersIdentified\": 13445, \"ordersIdentified\": 22283, \"ordersAnonymous\": 148\n  },\n  \"byStatus\": [\n    { \"status\": \"completed\", \"orders\": 22431, \"revenue\": 4936614695 },\n    { \"status\": \"canceled\",  \"orders\": 448,   \"revenue\": 113308848 }\n  ],\n  \"updatedThrough\": \"2026-09-02 18:05:03\",\n  \"comparison\": {\n    \"period\": { \"start\": \"2026-07-01\", \"end\": \"2026-07-31\", \"label\": \"previous\" },\n    \"total\": {\n      \"orders\": 23633, \"revenue\": 4585023678, \"averageTicket\": 194009,\n      \"customersIdentified\": 14139, \"ordersIdentified\": 23490, \"ordersAnonymous\": 143\n    },\n    \"delta\": {\n      \"orders\":        { \"abs\": -1202,      \"pct\": -0.0509 },\n      \"revenue\":       { \"abs\": 351591017,  \"pct\": 0.0767 },\n      \"averageTicket\": { \"abs\": 26071,      \"pct\": 0.1344 }\n    }\n  }\n}"
                                },
                                {
                                    "name": "Invalid `groupBy`, `status`, `compareWith`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/order/report/sales/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "order",
                                                "report",
                                                "sales",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Aggregated sales/revenue for a period, broken down by day, month, store or\nintegration channel (`interface`) — the answer to \"how much did I sell\nyesterday\", \"revenue by store this month\", \"sales per channel\", \"average\nticket per period\". Returns totals plus a per-status breakdown; each row/total\ncarries `revenue` and `discounts`. Filter to a cohort with `client`.\n\n**Revenue is net of cancellations by default** (canceled orders are excluded\nfrom the total). The `byStatus` block always reports every status, including\ncanceled, so what was left out stays auditable.\n\nEvery total carries **`mix`**, the revenue broken down from list price to what\nactually came in — the answer to \"what is my net revenue\", \"how much did I\ngive away in discount\", \"what did the loyalty program cost me\":\n\n| field | meaning |\n|---|---|\n| `listRevenue` | list price — `revenue + discounts` |\n| `discount` | what the store gave up |\n| `incentive` | balance the program paid (`null` without `withAttribution`) |\n| `netRevenue` | what came in — `revenue − incentive` (`null` without `withAttribution`) |\n| `averageTicket` | **ASP**, the average price actually charged |\n| `listAverageTicket` | **OSP**, the average list price, before discount |\n\n⚠️ **`revenue` is already net of the commercial discount** — an item's `price`\nis the unit price after discount. So list price is `revenue` **plus**\n`discounts`, not minus. Subtracting the discount from `revenue` counts it\ntwice, and it is the most common way to get this number wrong.\n\n⚠️ Do **not** confuse `mix` with `attribution.revenueGross` / `revenueNet`:\nthose are scoped to the attributed orders only, while `mix` is the whole\nbusiness.\n\n⚠️ `listRevenue` and `listAverageTicket` are only as good as `total_discounts`.\nWhere the integration does not send \"list price minus sale price\" the number\ndoes not hold — `ordersDiscountOverRevenue`, in the same total, counts the\norders whose discount is bigger than the sale itself.\n\nEvery total and row also carries the headline counts: **`orders`**, **`revenue`**,\n**`averageTicket`**, and **`customersIdentified`** — the number of **unique\nbuyers** (distinct customers, `COUNT(DISTINCT client)`): how many different\npeople bought — plus **`ordersIdentified`** / **`ordersAnonymous`** (orders with\nvs. without an identified customer). So \"sales by day with average ticket and\nunique buyers\" is a single call: this report with `groupBy=day` (add\n`membership=member` for members only). `customersIdentified` counts identified\nbuyers only — an anonymous order has no customer to count.\n\nPass **`compareWith`** to get a period-over-period comparison: the response\nadds a `comparison` block with the baseline period's total and the `delta`\n(absolute and percent) on orders, revenue and average ticket — so you can\nanswer \"sold X, +12% vs last month\".\n\nPass **`withAttribution`** for revenue **attributed to campaigns** — the total\nvalue of the **sales where a campaign's cashback / balance was redeemed** or\nwhose message drove the purchase, and the same broken down **per campaign**\n(`topCampaigns=N`), so you can answer \"how much did campaign X's cashback\ngenerate\" and the **ticket per campaign**. This is influenced revenue, not\nincremental. The block also splits **attributed** sales (balance redeemed),\n**influenced** ones (only got the message and bought) and the **impacted**\ntotal (the sum) in `split`. Within the attributed sales, `split` also separates\n**cashback** (redeemed, no push) from **push** (redeemed *and* a push\nnotification — push wins the tie), so you can read the push-assisted revenue\napart from organic cashback; `cashback + push = attributed`. The split is in\n`byDay` and in the `byStore`/`byInterface` breakdowns too (cashback vs push by\nchannel and month).\n\nValues are in **cents**. The day is cut from `order_date` (the business date)\nconverted to the organization timezone, so a sale rings up on the day it\nhappened, not the day it synced. `updatedThrough` is the newest `createAt`\nthat entered the calculation — because orders arrive after the sale,\n\"yesterday\" is a moving number; use it to decide whether to refetch.\n\nSupersedes `financeSumary`, which summed cancellations, dropped the last day\nof the period and grouped in UTC."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Organization",
            "item": [
                {
                    "name": "Account Activate",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/activate",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "activate"
                            ]
                        },
                        "description": "Re-activates a previously deactivated account."
                    },
                    "response": [
                        {
                            "name": "Activated",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/activate",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "activate"
                                    ]
                                },
                                "description": "Re-activates a previously deactivated account."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"organization\": \"acme\",\n    \"active\": true,\n    \"activatedAt\": \"2026-05-01T12:34:56-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Account Deactivate",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/deactivate",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "deactivate"
                            ]
                        },
                        "description": "Deactivates the account, suspending its access to Guper services."
                    },
                    "response": [
                        {
                            "name": "Deactivated",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/deactivate",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "deactivate"
                                    ]
                                },
                                "description": "Deactivates the account, suspending its access to Guper services."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"organization\": \"acme\",\n    \"active\": false,\n    \"deactivatedAt\": \"2026-05-01T12:34:56-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Create Account",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/createAccount",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "createAccount"
                            ]
                        },
                        "description": "Creates a new tenant account (organization) in the platform.",
                        "body": {
                            "mode": "raw",
                            "raw": "{\r\n    \"account\": \"acme\",\r\n    \"name\": \"Acme\",\r\n    \"language\": \"en_US\",\r\n    \"currency\": \"USD\"\r\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Created",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/createAccount",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "createAccount"
                                    ]
                                },
                                "description": "Creates a new tenant account (organization) in the platform.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"account\": \"acme\",\r\n    \"name\": \"Acme\",\r\n    \"language\": \"en_US\",\r\n    \"currency\": \"USD\"\r\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"organization\": \"acme\",\n    \"name\": \"ACME\",\n    \"currency\": \"BRL\",\n    \"createdAt\": \"2026-05-01T12:34:56-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Get Account",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account"
                            ]
                        },
                        "description": "Returns the current account details (name, services, currency, etc.)."
                    },
                    "response": [
                        {
                            "name": "OK",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account"
                                    ]
                                },
                                "description": "Returns the current account details (name, services, currency, etc.)."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"organization\": \"acme\",\n    \"name\": \"ACME\",\n    \"currency\": \"BRL\",\n    \"services\": [\"loyalty\", \"order\", \"register\"],\n    \"active\": true\n}"
                        }
                    ]
                },
                {
                    "name": "Get account service scope",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/service/scope",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "service",
                                "scope"
                            ]
                        },
                        "description": "Returns the access scopes/permissions granted to the account services."
                    },
                    "response": [
                        {
                            "name": "OK",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/service/scope",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "service",
                                        "scope"
                                    ]
                                },
                                "description": "Returns the access scopes/permissions granted to the account services."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"service\": \"loyalty\",\n    \"scopes\": [\"read\", \"write\", \"admin\"]\n}"
                        }
                    ]
                },
                {
                    "name": "Grant services",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/services",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "services"
                            ]
                        },
                        "description": "Make sure to use a token generated from a **developer** account to grant access to an organization's services.",
                        "body": {
                            "mode": "raw",
                            "raw": "[\r\n    \"register\",\r\n    \"loyalty\",\r\n    \"connect\",\r\n    \"order\",\r\n    \"sender\"\r\n]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Granted",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/services",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "services"
                                    ]
                                },
                                "description": "Make sure to use a token generated from a **developer** account to grant access to an organization's services.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "[\r\n    \"register\",\r\n    \"loyalty\",\r\n    \"connect\",\r\n    \"order\",\r\n    \"sender\"\r\n]",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"granted\": [\"loyalty\", \"sender\"]\n}"
                        }
                    ]
                },
                {
                    "name": "Has account service",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/hasService",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "hasService"
                            ]
                        },
                        "description": "Returns whether the account has a given service granted."
                    },
                    "response": [
                        {
                            "name": "OK",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/hasService",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "hasService"
                                    ]
                                },
                                "description": "Returns whether the account has a given service granted."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"service\": \"loyalty\",\n    \"granted\": true\n}"
                        }
                    ]
                },
                {
                    "name": "List Account",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/list",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "list"
                            ]
                        },
                        "description": "Returns the paginated list of tenant accounts (admin-only)."
                    },
                    "response": [
                        {
                            "name": "Paginated list",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/list",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "list"
                                    ]
                                },
                                "description": "Returns the paginated list of tenant accounts (admin-only)."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"list\": [\n        { \"organization\": \"acme\", \"name\": \"ACME\", \"active\": true },\n        { \"organization\": \"globex\", \"name\": \"Globex\", \"active\": false }\n    ],\n    \"total\": 2\n}"
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            },
                            {
                                "key": "signature",
                                "value": "{{signature}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "User-Agent",
                                "value": "{{User-Agent}}",
                                "type": "text",
                                "description": ""
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "ping"
                            ]
                        },
                        "description": "Returns `pong` to confirm the service is reachable."
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "signature",
                                        "value": "{{signature}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "ping"
                                    ]
                                },
                                "description": "Returns `pong` to confirm the service is reachable."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": ""
                        }
                    ]
                },
                {
                    "name": "Revoke services",
                    "request": {
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": ""
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/account/services",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "account",
                                "services"
                            ]
                        },
                        "description": "Revokes one or more services from the account.",
                        "body": {
                            "mode": "raw",
                            "raw": "[\r\n    \"register\"\r\n]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Revoked",
                            "originalRequest": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/account/services",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "account",
                                        "services"
                                    ]
                                },
                                "description": "Revokes one or more services from the account.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "[\r\n    \"register\"\r\n]",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"revoked\": [\"sender\"]\n}"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Register",
            "item": [
                {
                    "name": "Audience list",
                    "item": [
                        {
                            "name": "List",
                            "item": [
                                {
                                    "name": "Create audience list",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "audience-list"
                                            ]
                                        },
                                        "description": "Creates a new audience list (`register.list` row) — the segment of customers\nused by campaigns, messaging, and broadcast endpoints. Only `name` is required;\neverything else describes how the list is populated:\n\n- `listType: manual` — members are added one-by-one via the `audience-list/{id}/person` endpoints.\n- `listType: query` — `parameters` holds an Audience Query (QON) that resolves dynamically.\n- `listType: import` — used by the file-import flow; consumers should set the import fields via the dedicated upload endpoint instead of crafting them here.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"VIP customers — May campaign\",\n    \"status\": \"new\",\n    \"listType\": \"manual\",\n    \"parameters\": {},\n    \"contentHash\": \"<contentHash>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Audience list created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "audience-list"
                                                    ]
                                                },
                                                "description": "Creates a new audience list (`register.list` row) — the segment of customers\nused by campaigns, messaging, and broadcast endpoints. Only `name` is required;\neverything else describes how the list is populated:\n\n- `listType: manual` — members are added one-by-one via the `audience-list/{id}/person` endpoints.\n- `listType: query` — `parameters` holds an Audience Query (QON) that resolves dynamically.\n- `listType: import` — used by the file-import flow; consumers should set the import fields via the dedicated upload endpoint instead of crafting them here.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"VIP customers — May campaign\",\n    \"status\": \"new\",\n    \"listType\": \"manual\",\n    \"parameters\": {},\n    \"contentHash\": \"<contentHash>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 42,\n    \"name\": \"VIP customers — May campaign\",\n    \"status\": \"new\",\n    \"listType\": \"manual\",\n    \"parameters\": null,\n    \"contentHash\": null,\n    \"importStep\": null,\n    \"importTotalRecords\": null,\n    \"importStatsFound\": null,\n    \"importStatsNotFound\": null,\n    \"importStatsInvalid\": null\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Fetch list",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "audience-list"
                                            ]
                                        },
                                        "description": "Returns the audience lists belonging to the organization."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "audience-list"
                                                    ]
                                                },
                                                "description": "Returns the audience lists belonging to the organization."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove audience list",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "audience-list"
                                            ]
                                        },
                                        "description": "Removes an audience list (soft-delete via `Tools\\Data\\Delete`). The ID goes in\nthe request body, not in the URL.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 42\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Audience list removed.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "audience-list"
                                                    ]
                                                },
                                                "description": "Removes an audience list (soft-delete via `Tools\\Data\\Delete`). The ID goes in\nthe request body, not in the URL.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 42\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Update audience list",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "audience-list"
                                            ]
                                        },
                                        "description": "Updates an existing audience list. Only `id` is required; any other field\npresent in the body is updated, anything omitted is left untouched.\n\n> Avoid mutating the `import*` fields manually — they are owned by the\n> import cron pipeline.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 42,\n    \"name\": \"VIP customers — May campaign\",\n    \"status\": \"processed\",\n    \"listType\": \"manual\",\n    \"parameters\": {},\n    \"contentHash\": \"<contentHash>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Audience list updated.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/audience-list",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "audience-list"
                                                    ]
                                                },
                                                "description": "Updates an existing audience list. Only `id` is required; any other field\npresent in the body is updated, anything omitted is left untouched.\n\n> Avoid mutating the `import*` fields manually — they are owned by the\n> import cron pipeline.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 42,\n    \"name\": \"VIP customers — May campaign\",\n    \"status\": \"processed\",\n    \"listType\": \"manual\",\n    \"parameters\": {},\n    \"contentHash\": \"<contentHash>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Custom Fields",
                    "item": [
                        {
                            "name": "List custom fields",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/custom-field",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "custom-field"
                                    ]
                                },
                                "description": "Lists the organization's metadata keys (the *custom-field* catalog). Keys are\ncreated automatically the first time a value is written for them (via Data\nCapture or the `customer/{id}/metadata` endpoint) — this endpoint is mainly for\nbuilding pickers and management screens. `type` is a best-effort hint\n(`text` / `number` / `date`) inferred from the values seen; `label` is an\noptional friendly name set by an admin."
                            },
                            "response": [
                                {
                                    "name": "Paginated list of custom-field definitions.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/custom-field",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "custom-field"
                                            ]
                                        },
                                        "description": "Lists the organization's metadata keys (the *custom-field* catalog). Keys are\ncreated automatically the first time a value is written for them (via Data\nCapture or the `customer/{id}/metadata` endpoint) — this endpoint is mainly for\nbuilding pickers and management screens. `type` is a best-effort hint\n(`text` / `number` / `date`) inferred from the values seen; `label` is an\noptional friendly name set by an admin."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        { \"id\": 1, \"metaKey\": \"kid_birthday\", \"label\": \"Kid's birthday\", \"type\": \"date\" },\n        { \"id\": 2, \"metaKey\": \"shirt_size\",   \"label\": null,             \"type\": \"text\" }\n    ],\n    \"page\": 1,\n    \"pages\": 1\n}"
                                }
                            ]
                        },
                        {
                            "name": "Delete custom field",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/custom-field",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "custom-field"
                                    ]
                                },
                                "description": "Removes a metadata key from the organization **and deletes all of its values**\nacross every person (`person_custom_field`). Destructive and irreversible —\nconfirm before calling. Returns how many person values were removed.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"metaKey\": \"shirt_size\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Key and its values removed.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/custom-field",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "custom-field"
                                            ]
                                        },
                                        "description": "Removes a metadata key from the organization **and deletes all of its values**\nacross every person (`person_custom_field`). Destructive and irreversible —\nconfirm before calling. Returns how many person values were removed.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"metaKey\": \"shirt_size\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"metaKey\": \"shirt_size\",\n    \"valuesRemoved\": 42\n}"
                                }
                            ]
                        },
                        {
                            "name": "Set custom field label",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/custom-field",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "custom-field"
                                    ]
                                },
                                "description": "Sets the friendly `label` of a metadata key. Only the label is editable — the\n`metaKey` itself is immutable (it is the storage key) and `type` is inferred.\nIf the key does not exist yet, no row is affected.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"metaKey\": \"shirt_size\",\n    \"label\": \"Shirt size\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "The updated key/label.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/custom-field",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "custom-field"
                                            ]
                                        },
                                        "description": "Sets the friendly `label` of a metadata key. Only the label is editable — the\n`metaKey` itself is immutable (it is the storage key) and `type` is inferred.\nIf the key does not exist yet, no row is affected.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"metaKey\": \"shirt_size\",\n    \"label\": \"Shirt size\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"metaKey\": \"shirt_size\",\n    \"label\": \"Shirt size\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Customer",
                    "item": [
                        {
                            "name": "Create customer",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer"
                                    ]
                                },
                                "description": "Creates a new customer (`isCustomer = 1` in `register.person`). The `name` field is\nrequired; at least one of `cellphone`, `email`, or `document` must also be supplied\nso the record can be matched later (see `matchPattern` on the organization). The\npayload goes through `Person\\Sanitize` — phone is normalized via `libphonenumber`,\nemail is lower-cased, document keeps only alphanumerics and is lower-cased.\n\nOn success, the freshly created person is returned with the default *Rookie* tag\nalready assigned and a history record (`Create person`) inserted.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\",\n    \"optin\": \"2026-05-03T10:00:00-03:00\",\n    \"privacyAccepted\": \"2026-05-03T10:00:00-03:00\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Customer created.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer"
                                            ]
                                        },
                                        "description": "Creates a new customer (`isCustomer = 1` in `register.person`). The `name` field is\nrequired; at least one of `cellphone`, `email`, or `document` must also be supplied\nso the record can be matched later (see `matchPattern` on the organization). The\npayload goes through `Person\\Sanitize` — phone is normalized via `libphonenumber`,\nemail is lower-cased, document keeps only alphanumerics and is lower-cased.\n\nOn success, the freshly created person is returned with the default *Rookie* tag\nalready assigned and a history record (`Create person`) inserted.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\",\n    \"optin\": \"2026-05-03T10:00:00-03:00\",\n    \"privacyAccepted\": \"2026-05-03T10:00:00-03:00\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 683752,\n    \"mainId\": null,\n    \"entityType\": \"individual\",\n    \"name\": \"Tintin\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"document\": \"32165987\",\n    \"gender\": \"male\",\n    \"postalCode\": \"13450000\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"language\": \"pt_BR\",\n    \"createdAt\": \"2026-05-03T10:00:00-03:00\",\n    \"updatedAt\": \"2026-05-03T10:00:00-03:00\"\n}"
                                },
                                {
                                    "name": "Insufficient data — none of `name`, `cellphone`, `email`, `document` were provided.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer"
                                            ]
                                        },
                                        "description": "Creates a new customer (`isCustomer = 1` in `register.person`). The `name` field is\nrequired; at least one of `cellphone`, `email`, or `document` must also be supplied\nso the record can be matched later (see `matchPattern` on the organization). The\npayload goes through `Person\\Sanitize` — phone is normalized via `libphonenumber`,\nemail is lower-cased, document keeps only alphanumerics and is lower-cased.\n\nOn success, the freshly created person is returned with the default *Rookie* tag\nalready assigned and a history record (`Create person`) inserted.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\",\n    \"optin\": \"2026-05-03T10:00:00-03:00\",\n    \"privacyAccepted\": \"2026-05-03T10:00:00-03:00\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 412,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Feed",
                            "item": [
                                {
                                    "name": "Commit items",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feed",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feed"
                                            ]
                                        },
                                        "description": "Acknowledges consumption of customer feed entries by sending the tokens back. Once acknowledged, those entries no longer appear in subsequent reads.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"tokens\": [\r\n        \"5BE6DABCFEC711EFAAC602B02E860C9523628\"\r\n    ]\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Acknowledged",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feed",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feed"
                                                    ]
                                                },
                                                "description": "Acknowledges consumption of customer feed entries by sending the tokens back. Once acknowledged, those entries no longer appear in subsequent reads.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\r\n    \"tokens\": [\r\n        \"5BE6DABCFEC711EFAAC602B02E860C9523628\"\r\n    ]\r\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"acknowledged\": 2\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Retrieve items",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feed",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feed"
                                            ]
                                        },
                                        "description": "Retrieves pending entries from the customer feed (customers created, updated, tagged or otherwise modified since the last acknowledgement)."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feed",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feed"
                                                    ]
                                                },
                                                "description": "Retrieves pending entries from the customer feed (customers created, updated, tagged or otherwise modified since the last acknowledgement)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"confirmToken\": \"2A0067C7FECB11EFAAC602B02E860C9532173\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"person\",\n        \"key\": 71918412,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T16:50:00-03:00\"\n    },\n    {\n        \"confirmToken\": \"409FBC97FED111EFAAC602B02E860C9578560\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"person\",\n        \"key\": 71928432,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T17:33:35-03:00\"\n    },\n    {\n        \"confirmToken\": \"65as4d6as85d49qd51q69we54q9w58de496sa\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"person\",\n        \"key\": 71896943,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T14:41:14-03:00\"\n    },\n    {\n        \"confirmToken\": \"8374E01DFEC111EFAAC602B02E860C9555273\",\n        \"subscriber\": \"cloe-acme-TARQTDBN\",\n        \"module\": \"person\",\n        \"key\": 71906811,\n        \"confirmedAt\": null,\n        \"createdAt\": \"2025-03-11T15:40:55-03:00\"\n    }\n]"
                                        },
                                        {
                                            "name": "Empty",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feed",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feed"
                                                    ]
                                                },
                                                "description": "Retrieves pending entries from the customer feed (customers created, updated, tagged or otherwise modified since the last acknowledgement)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[]"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Get Customer",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer",
                                        "{{person}}"
                                    ]
                                },
                                "description": "Returns a single customer by its identifier, enriched with all related data\navailable for that person: RFM metrics, attributes, active tags, referral,\nwatchlist, tier and membership.\n\nThe base fields are always present. The nested objects (`rfm`, `attributes`,\n`store`, `tags`, `referral`, `watchlist`, `tier`, `membership`, `lifecycle`,\n`metadata`) are included only when the customer has the corresponding records —\nwhen absent, the key is omitted from the response. `firstName`/`lastName` are\nderived from `name`.\n\n**`metadata`** is a flat `{ metaKey: value }` object of the person's custom\nfields (free key/value metadata). See the Custom Fields guide and the\n`customer/{id}/metadata` endpoints.\n\n**`lifecycle`** carries the customer's stage — `stage` is one of `lead`,\n`customer` or `churn`. When `stage` is `customer`, `churnAt` is the predicted\ndate the customer turns to churn if they don't buy again (it moves forward on\nevery purchase); when `stage` is `churn`, `churnedAt` is when they became\ninactive. The same stage is also present in `tags` as `Lead`/`Customer`/`Churn`\n(tags `5`/`6`/`7`). See the Customer Lifecycle guide."
                            },
                            "response": [
                                {
                                    "name": "Successful Response",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{person}}"
                                            ]
                                        },
                                        "description": "Returns a single customer by its identifier, enriched with all related data\navailable for that person: RFM metrics, attributes, active tags, referral,\nwatchlist, tier and membership.\n\nThe base fields are always present. The nested objects (`rfm`, `attributes`,\n`store`, `tags`, `referral`, `watchlist`, `tier`, `membership`, `lifecycle`,\n`metadata`) are included only when the customer has the corresponding records —\nwhen absent, the key is omitted from the response. `firstName`/`lastName` are\nderived from `name`.\n\n**`metadata`** is a flat `{ metaKey: value }` object of the person's custom\nfields (free key/value metadata). See the Custom Fields guide and the\n`customer/{id}/metadata` endpoints.\n\n**`lifecycle`** carries the customer's stage — `stage` is one of `lead`,\n`customer` or `churn`. When `stage` is `customer`, `churnAt` is the predicted\ndate the customer turns to churn if they don't buy again (it moves forward on\nevery purchase); when `stage` is `churn`, `churnedAt` is when they became\ninactive. The same stage is also present in `tags` as `Lead`/`Customer`/`Churn`\n(tags `5`/`6`/`7`). See the Customer Lifecycle guide."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 4224868,\n    \"mainId\": null,\n    \"entityType\": null,\n    \"name\": \"ivone suerez\",\n    \"email\": \"freshcoolingscsa@gmail.com\",\n    \"countryCallingCode\": 52,\n    \"cellphone\": \"2224366229\",\n    \"document\": null,\n    \"gender\": \"female\",\n    \"postalCode\": \"72000\",\n    \"dateOfBirth\": \"1984-02-13T00:00:00-03:00\",\n    \"language\": null,\n    \"flags\": null,\n    \"matchWith\": null,\n    \"isHomologation\": 0,\n    \"validatedAt\": \"2026-05-28T23:19:11-03:00\",\n    \"pinType\": \"dynamic\",\n    \"pinExpiresAt\": \"2026-05-28T23:48:35-03:00\",\n    \"optin\": \"2026-05-28T23:18:34-03:00\",\n    \"privacyAccepted\": null,\n    \"createdAt\": \"2026-05-28T20:17:11-03:00\",\n    \"updatedAt\": \"2026-05-28T20:19:10-03:00\",\n    \"firstName\": \"Ivone\",\n    \"lastName\": \"Suerez\",\n    \"rfm\": {\n        \"firstPurchaseId\": 5578246,\n        \"lastPurchaseId\": 5578246,\n        \"firstPurchaseDate\": \"2026-05-28T20:20:26-03:00\",\n        \"lastPurchaseDate\": \"2026-05-28T20:20:26-03:00\",\n        \"averagePurchaseInterval\": 0,\n        \"totalPurchaseValue\": 481003,\n        \"totalPurchases\": 1,\n        \"daysWithoutPurchase\": 0,\n        \"lastRewardCardId\": 1801158,\n        \"lastRewardCardDate\": \"2026-05-28T23:20:26-03:00\"\n    },\n    \"attributes\": {\n        \"firstStore\": 12,\n        \"lastStore\": 12,\n        \"lastSalesperson\": null,\n        \"flags\": null\n    },\n    \"store\": 12,\n    \"tags\": [\n        {\n            \"tag\": 6,\n            \"name\": \"Customer\",\n            \"createdAt\": \"2026-05-28T20:20:26-03:00\"\n        },\n        {\n            \"tag\": 2,\n            \"name\": \"Opt-in\",\n            \"createdAt\": \"2026-05-28T20:18:34-03:00\"\n        },\n        {\n            \"tag\": 453,\n            \"name\": \"Cashback Silver - Boutique\",\n            \"createdAt\": \"2026-05-28T20:20:26-03:00\"\n        },\n        {\n            \"tag\": 90,\n            \"name\": \"Gold\",\n            \"createdAt\": \"2026-05-28T20:20:26-03:00\"\n        }\n    ],\n    \"referral\": {\n        \"person\": 4220011,\n        \"expiredAt\": \"2026-06-28T20:17:11-03:00\"\n    },\n    \"watchlist\": [\n        {\n            \"listType\": \"blocklist\",\n            \"reason\": \"fraud suspicion\",\n            \"syncedAt\": \"2026-05-28T20:17:11-03:00\"\n        }\n    ],\n    \"tier\": {\n        \"tierConfig\": 2,\n        \"activePoints\": 4810,\n        \"levelId\": 2,\n        \"levelName\": \"Gold\",\n        \"nextLevel\": \"Platinum\",\n        \"pointsToNext\": 3190\n    },\n    \"membership\": {\n        \"isMember\": true,\n        \"tierConfig\": 2,\n        \"joinedAt\": \"2026-05-28T23:18:34-03:00\"\n    },\n    \"lifecycle\": {\n        \"stage\": \"customer\",\n        \"churnAt\": \"2026-08-25T20:20:26-03:00\",\n        \"churnedAt\": null\n    },\n    \"metadata\": {\n        \"shirt_size\": \"M\",\n        \"kid_birthday\": \"2015-03-01\"\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Get or Create",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "Signature",
                                        "value": "{{Signature}}",
                                        "type": "text",
                                        "description": ""
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/findOrCreate",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer",
                                        "findOrCreate"
                                    ]
                                },
                                "description": "Looks up a customer matching the provided identifiers (cellphone, email, document, etc.). If no match, creates a new customer with that data and returns it.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"name\": \"Tintin\",\r\n    \"email\": \"tintin@tintin.com.br\",\r\n    \"cellphone\": \"+55 19 9 8245-6598\",\r\n    \"id\": 23\r\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Found / created",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": ""
                                            },
                                            {
                                                "key": "Signature",
                                                "value": "{{Signature}}",
                                                "type": "text",
                                                "description": ""
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/findOrCreate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "findOrCreate"
                                            ]
                                        },
                                        "description": "Looks up a customer matching the provided identifiers (cellphone, email, document, etc.). If no match, creates a new customer with that data and returns it.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"name\": \"Tintin\",\r\n    \"email\": \"tintin@tintin.com.br\",\r\n    \"cellphone\": \"+55 19 9 8245-6598\",\r\n    \"id\": 23\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 44,\n    \"created\": false,\n    \"name\": \"Maria Silva\",\n    \"cellphone\": \"19954264546\",\n    \"email\": \"maria@example.com\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Lifecycle",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/lifecycle",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer",
                                        "lifecycle"
                                    ]
                                },
                                "description": "Returns a paginated list of customer **IDs** filtered by lifecycle stage or by\nchurn forecast. Reads directly from the scheduled lifecycle tags — `5` (Lead),\n`6` (Customer), `7` (Churn). See the [Customer Lifecycle guide](/en-US/guides/customer-lifecycle).\n\nUse it to build audiences such as *\"already churned\"* or *\"customers who will\nchurn within N days / by a given date\"* — ideal to feed campaigns, exports or\nintegrations. For a single customer's stage plus its churn forecast (`churnAt`),\nuse the `lifecycle` object in [Get customer](/en-US/api-reference/register/customer/get).\n\nProvide **either** `stage` **or** one of `churnWithinDays` / `churnUntil`.\nThe churn-forecast params imply the Customer stage (an active customer whose\npredicted churn date falls between now and the given ceiling) and take\nprecedence over `stage`."
                            },
                            "response": [
                                {
                                    "name": "Success — churned customers (`?stage=churn`).",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/lifecycle",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "lifecycle"
                                            ]
                                        },
                                        "description": "Returns a paginated list of customer **IDs** filtered by lifecycle stage or by\nchurn forecast. Reads directly from the scheduled lifecycle tags — `5` (Lead),\n`6` (Customer), `7` (Churn). See the [Customer Lifecycle guide](/en-US/guides/customer-lifecycle).\n\nUse it to build audiences such as *\"already churned\"* or *\"customers who will\nchurn within N days / by a given date\"* — ideal to feed campaigns, exports or\nintegrations. For a single customer's stage plus its churn forecast (`churnAt`),\nuse the `lifecycle` object in [Get customer](/en-US/api-reference/register/customer/get).\n\nProvide **either** `stage` **or** one of `churnWithinDays` / `churnUntil`.\nThe churn-forecast params imply the Customer stage (an active customer whose\npredicted churn date falls between now and the given ceiling) and take\nprecedence over `stage`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [44356, 44409, 44411, 44526, 44202],\n    \"total\": 291721,\n    \"pagination\": { \"entries\": 5, \"totalPages\": 58345, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": false }\n}"
                                },
                                {
                                    "name": "Success — customers about to churn within 7 days (`?churnWithinDays=7`).",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/lifecycle",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "lifecycle"
                                            ]
                                        },
                                        "description": "Returns a paginated list of customer **IDs** filtered by lifecycle stage or by\nchurn forecast. Reads directly from the scheduled lifecycle tags — `5` (Lead),\n`6` (Customer), `7` (Churn). See the [Customer Lifecycle guide](/en-US/guides/customer-lifecycle).\n\nUse it to build audiences such as *\"already churned\"* or *\"customers who will\nchurn within N days / by a given date\"* — ideal to feed campaigns, exports or\nintegrations. For a single customer's stage plus its churn forecast (`churnAt`),\nuse the `lifecycle` object in [Get customer](/en-US/api-reference/register/customer/get).\n\nProvide **either** `stage` **or** one of `churnWithinDays` / `churnUntil`.\nThe churn-forecast params imply the Customer stage (an active customer whose\npredicted churn date falls between now and the given ceiling) and take\nprecedence over `stage`."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [4169452, 4169450, 4169459, 4169464, 4169463],\n    \"total\": 2252,\n    \"pagination\": { \"entries\": 5, \"totalPages\": 451, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": false }\n}"
                                },
                                {
                                    "name": "No filter provided.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/lifecycle",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "lifecycle"
                                            ]
                                        },
                                        "description": "Returns a paginated list of customer **IDs** filtered by lifecycle stage or by\nchurn forecast. Reads directly from the scheduled lifecycle tags — `5` (Lead),\n`6` (Customer), `7` (Churn). See the [Customer Lifecycle guide](/en-US/guides/customer-lifecycle).\n\nUse it to build audiences such as *\"already churned\"* or *\"customers who will\nchurn within N days / by a given date\"* — ideal to feed campaigns, exports or\nintegrations. For a single customer's stage plus its churn forecast (`churnAt`),\nuse the `lifecycle` object in [Get customer](/en-US/api-reference/register/customer/get).\n\nProvide **either** `stage` **or** one of `churnWithinDays` / `churnUntil`.\nThe churn-forecast params imply the Customer stage (an active customer whose\npredicted churn date falls between now and the given ceiling) and take\nprecedence over `stage`."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": true,\n    \"message\": \"Provide stage (lead|customer|churn) or churnWithinDays/churnUntil\",\n    \"status_code\": 400\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Customers",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer"
                                    ]
                                },
                                "description": "Returns a paginated list of customers, and is also **how you look a customer up\nby e-mail, document or phone** — filter the listing instead of calling a\nseparate endpoint, because there is no separate endpoint.\n\nFiltering uses the shared listing grammar `q[column][operator]=value`,\ndocumented in full under [List query parameters](/docs/{lang}/guides/list-query-parameters).\nAny column of the response can be filtered.\n\n```\nGET /api/register/customer?q[email][E]=someone@example.com\nGET /api/register/customer?q[document][E]=12345678900\nGET /api/register/customer?q[email][LRL]=gmail&e=20\n```\n\n`E` is exact match — the one to use when you already have the address in hand.\n`LRL` is \"contains\", useful for partial searches. Combine columns freely.\n\nThe endpoint is read-only. To resolve an identifier **and create the customer\nif missing**, that is a different operation (`Get or create customer`) and it\nwrites — do not reach for it just to look someone up."
                            },
                            "response": [
                                {
                                    "name": "Successful response",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer"
                                            ]
                                        },
                                        "description": "Returns a paginated list of customers, and is also **how you look a customer up\nby e-mail, document or phone** — filter the listing instead of calling a\nseparate endpoint, because there is no separate endpoint.\n\nFiltering uses the shared listing grammar `q[column][operator]=value`,\ndocumented in full under [List query parameters](/docs/{lang}/guides/list-query-parameters).\nAny column of the response can be filtered.\n\n```\nGET /api/register/customer?q[email][E]=someone@example.com\nGET /api/register/customer?q[document][E]=12345678900\nGET /api/register/customer?q[email][LRL]=gmail&e=20\n```\n\n`E` is exact match — the one to use when you already have the address in hand.\n`LRL` is \"contains\", useful for partial searches. Combine columns freely.\n\nThe endpoint is read-only. To resolve an identifier **and create the customer\nif missing**, that is a different operation (`Get or create customer`) and it\nwrites — do not reach for it just to look someone up."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 536813,\n            \"entityType\": \"individual\",\n            \"name\": \"Rodrigo Dechen\",\n            \"email\": \"rodrigo@gmail.com\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"11987654321\",\n            \"document\": null,\n            \"gender\": null,\n            \"dateOfBirth\": null,\n            \"createdAt\": \"2024-03-11T09:20:41-03:00\",\n            \"updatedAt\": \"2026-02-02T18:05:12-03:00\"\n        }\n    ],\n    \"total\": 1\n}"
                                }
                            ]
                        },
                        {
                            "name": "Merge",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/merge",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "merge"
                                    ]
                                },
                                "description": "Merges two person records into one — useful when duplicates are detected. The resulting record keeps history from both.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\r\n    \"mainPersonId\": 123,\r\n    \"mergePersonIds\": [456, 789]\r\n  }",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Merged",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/merge",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "merge"
                                            ]
                                        },
                                        "description": "Merges two person records into one — useful when duplicates are detected. The resulting record keeps history from both.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"mainPersonId\": 123,\r\n    \"mergePersonIds\": [456, 789]\r\n  }",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"keep\": 44,\n    \"merged\": 102,\n    \"affectedRecords\": 17\n}"
                                }
                            ]
                        },
                        {
                            "name": "Metadata",
                            "item": [
                                {
                                    "name": "Get customer metadata",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/metadata",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{id}}",
                                                "metadata"
                                            ]
                                        },
                                        "description": "Returns the person's metadata (custom fields) as a flat `{ metaKey: value }`\nobject. The same object is also embedded as `metadata` in the full customer\npayload (`GET /api/register/customer/{id}`). An empty object is returned when\nthe person has no metadata."
                                    },
                                    "response": [
                                        {
                                            "name": "Metadata map (empty object when the person has none).",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/metadata",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "metadata"
                                                    ]
                                                },
                                                "description": "Returns the person's metadata (custom fields) as a flat `{ metaKey: value }`\nobject. The same object is also embedded as `metadata` in the full customer\npayload (`GET /api/register/customer/{id}`). An empty object is returned when\nthe person has no metadata."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"shirt_size\": \"M\",\n    \"kid_birthday\": \"2015-03-01\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Upsert customer metadata",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/metadata",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{id}}",
                                                "metadata"
                                            ]
                                        },
                                        "description": "Partial upsert of a person's metadata. The body is a flat `{ metaKey: value }`\nobject — each key is created or updated. **Send a `null` or empty-string value\nto delete a key.** Keys not present in the body are left untouched.\n\nEach `metaKey` is slugified to `[a-z0-9_]` (max 64 chars) and rejected (422)\nif it collides with a fixed person column (e.g. `email`, `name`, `gender`).\nValues are stored as text; a numeric value also populates `valueNumber` and a\n`YYYY-MM-DD` value also populates `valueDate` (best-effort, for future\nsegmentation). New keys are auto-registered so they appear in the\n`custom-field` catalog.\n\nReturns the person's fresh, normalized metadata map.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"shirt_size\": \"G\",\n    \"kid_birthday\": \"2015-03-01\",\n    \"old_key\": null\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Fresh metadata map after the upsert.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/metadata",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "metadata"
                                                    ]
                                                },
                                                "description": "Partial upsert of a person's metadata. The body is a flat `{ metaKey: value }`\nobject — each key is created or updated. **Send a `null` or empty-string value\nto delete a key.** Keys not present in the body are left untouched.\n\nEach `metaKey` is slugified to `[a-z0-9_]` (max 64 chars) and rejected (422)\nif it collides with a fixed person column (e.g. `email`, `name`, `gender`).\nValues are stored as text; a numeric value also populates `valueNumber` and a\n`YYYY-MM-DD` value also populates `valueDate` (best-effort, for future\nsegmentation). New keys are auto-registered so they appear in the\n`custom-field` catalog.\n\nReturns the person's fresh, normalized metadata map.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shirt_size\": \"G\",\n    \"kid_birthday\": \"2015-03-01\",\n    \"old_key\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"shirt_size\": \"G\",\n    \"kid_birthday\": \"2015-03-01\"\n}"
                                        },
                                        {
                                            "name": "A `metaKey` collides with a fixed person column.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/metadata",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "metadata"
                                                    ]
                                                },
                                                "description": "Partial upsert of a person's metadata. The body is a flat `{ metaKey: value }`\nobject — each key is created or updated. **Send a `null` or empty-string value\nto delete a key.** Keys not present in the body are left untouched.\n\nEach `metaKey` is slugified to `[a-z0-9_]` (max 64 chars) and rejected (422)\nif it collides with a fixed person column (e.g. `email`, `name`, `gender`).\nValues are stored as text; a numeric value also populates `valueNumber` and a\n`YYYY-MM-DD` value also populates `valueDate` (best-effort, for future\nsegmentation). New keys are auto-registered so they appear in the\n`custom-field` catalog.\n\nReturns the person's fresh, normalized metadata map.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"shirt_size\": \"G\",\n    \"kid_birthday\": \"2015-03-01\",\n    \"old_key\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "OptIn",
                            "item": [
                                {
                                    "name": "Authorize",
                                    "request": {
                                        "method": "PATCH",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{id}}",
                                                "optin"
                                            ]
                                        },
                                        "description": "Records the customer's authorization (opt-in) to use their data for marketing/communications."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "PATCH",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "optin"
                                                    ]
                                                },
                                                "description": "Records the customer's authorization (opt-in) to use their data for marketing/communications."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2157344,\n    \"authorized\": true,\n    \"authorizedAt\": \"2025-07-04T13:30:35-03:00\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Opt-in",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{id}}",
                                                "optin"
                                            ]
                                        },
                                        "description": "Returns a single the customer matching the given identifier."
                                    },
                                    "response": [
                                        {
                                            "name": "Authorized",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "optin"
                                                    ]
                                                },
                                                "description": "Returns a single the customer matching the given identifier."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2157344,\n    \"authorized\": true,\n    \"authorizedAt\": \"2025-07-04T13:30:35-03:00\"\n}"
                                        },
                                        {
                                            "name": "Unauthorized",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "optin"
                                                    ]
                                                },
                                                "description": "Returns a single the customer matching the given identifier."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2157344,\n    \"authorized\": false,\n    \"authorizedAt\": null\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Revoke",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{id}}",
                                                "optin"
                                            ]
                                        },
                                        "description": "Revokes a previously granted opt-in. The customer's data is no longer used for marketing."
                                    },
                                    "response": [
                                        {
                                            "name": "Sccess",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/optin",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "optin"
                                                    ]
                                                },
                                                "description": "Revokes a previously granted opt-in. The customer's data is no longer used for marketing."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2157344,\n    \"authorized\": false,\n    \"authorizedAt\": null\n}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Pin",
                            "item": [
                                {
                                    "name": "Generate",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/pin",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{person}}",
                                                "pin"
                                            ]
                                        },
                                        "description": "Generates a numeric PIN and sends it to the customer (SMS/email). Used as second-factor for high-value redemptions."
                                    },
                                    "response": [
                                        {
                                            "name": "PIN sent",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/pin",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{person}}",
                                                        "pin"
                                                    ]
                                                },
                                                "description": "Generates a numeric PIN and sends it to the customer (SMS/email). Used as second-factor for high-value redemptions."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"channel\": \"whatsapp\",\n    \"sentTo\": \"+5519954264546\",\n    \"expiresAt\": \"2026-05-01T12:39:56-03:00\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Validate",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/pin/validate",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{person}}",
                                                "pin",
                                                "validate"
                                            ]
                                        },
                                        "description": "Validates a PIN entered by the customer at the POS or storefront. Returns success/failure.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\r\n    \"pin\": \"9663\"\r\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Valid",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/pin/validate",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{person}}",
                                                        "pin",
                                                        "validate"
                                                    ]
                                                },
                                                "description": "Validates a PIN entered by the customer at the POS or storefront. Returns success/failure.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\r\n    \"pin\": \"9663\"\r\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"valid\": true }"
                                        },
                                        {
                                            "name": "Invalid",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/pin/validate",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{person}}",
                                                        "pin",
                                                        "validate"
                                                    ]
                                                },
                                                "description": "Validates a PIN entered by the customer at the POS or storefront. Returns success/failure.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\r\n    \"pin\": \"9663\"\r\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unauthorized",
                                            "code": 401,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"valid\": false }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Referral",
                            "item": [
                                {
                                    "name": "Create referral",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/referral",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "referral"
                                            ]
                                        },
                                        "description": "Records a \"*who-referred-whom*\" relationship between two customers. Each `person`\ncan only have **one** active referrer at a time:\n\n- If no referral exists for `person`, one is created.\n- If a referral exists and is still **active** (`expiredAt > now`), the endpoint\n  refuses to switch the `referrer` (HTTP 409). Sending the *same* `referrer`\n  with a new `expiredAt` extends the window.\n- If the existing referral has already **expired**, the new payload replaces it.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 620287,\n    \"referrer\": 609961,\n    \"expiredAt\": \"2026-12-31 23:59:59\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Referral created or extended.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/referral",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "referral"
                                                    ]
                                                },
                                                "description": "Records a \"*who-referred-whom*\" relationship between two customers. Each `person`\ncan only have **one** active referrer at a time:\n\n- If no referral exists for `person`, one is created.\n- If a referral exists and is still **active** (`expiredAt > now`), the endpoint\n  refuses to switch the `referrer` (HTTP 409). Sending the *same* `referrer`\n  with a new `expiredAt` extends the window.\n- If the existing referral has already **expired**, the new payload replaces it.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"person\": 620287,\n    \"referrer\": 609961,\n    \"expiredAt\": \"2026-12-31 23:59:59\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"person\": 620287,\n    \"referrer\": 609961,\n    \"expiredAt\": \"2026-12-31T23:59:59-03:00\",\n    \"createdAt\": \"2026-05-03T10:00:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "A different referrer is already active for this person and has not expired yet.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/referral",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "referral"
                                                    ]
                                                },
                                                "description": "Records a \"*who-referred-whom*\" relationship between two customers. Each `person`\ncan only have **one** active referrer at a time:\n\n- If no referral exists for `person`, one is created.\n- If a referral exists and is still **active** (`expiredAt > now`), the endpoint\n  refuses to switch the `referrer` (HTTP 409). Sending the *same* `referrer`\n  with a new `expiredAt` extends the window.\n- If the existing referral has already **expired**, the new payload replaces it.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"person\": 620287,\n    \"referrer\": 609961,\n    \"expiredAt\": \"2026-12-31 23:59:59\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List Referrals",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/referral",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "referral"
                                            ]
                                        },
                                        "description": "Lists the referrals recorded for the organization - who indicated whom."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/referral",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "referral"
                                                    ]
                                                },
                                                "description": "Lists the referrals recorded for the organization - who indicated whom."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Remove customer",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer"
                                    ]
                                },
                                "description": "Soft-deletes a customer (the model uses the standard `Tools\\Data\\Delete` flow which\nmarks the row as removed). The customer ID goes in the request body, not in the URL.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 683752\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Customer removed.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer"
                                            ]
                                        },
                                        "description": "Soft-deletes a customer (the model uses the standard `Tools\\Data\\Delete` flow which\nmarks the row as removed). The customer ID goes in the request body, not in the URL.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 683752\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "RFM",
                            "item": [
                                {
                                    "name": "Get RFM",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/rfm",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{person}}",
                                                "rfm"
                                            ]
                                        },
                                        "description": "Returns the **R**ecency / **F**requency / **M**onetary record for a\nsingle person — first/last purchase, lifetime value, count, cadence,\nand the most recent reward card received. Refreshed automatically\nafter every order commit and whenever a reward card is issued.\n\nUsed by admin and segmentation flows to display a customer's\npurchasing snapshot. For listing many at once see\n[List RFM](/docs/{lang}/api-reference/register/customer/rfm/list)."
                                    },
                                    "response": [
                                        {
                                            "name": "RFM snapshot",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/rfm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{person}}",
                                                        "rfm"
                                                    ]
                                                },
                                                "description": "Returns the **R**ecency / **F**requency / **M**onetary record for a\nsingle person — first/last purchase, lifetime value, count, cadence,\nand the most recent reward card received. Refreshed automatically\nafter every order commit and whenever a reward card is issued.\n\nUsed by admin and segmentation flows to display a customer's\npurchasing snapshot. For listing many at once see\n[List RFM](/docs/{lang}/api-reference/register/customer/rfm/list)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"person\":                  643,\n    \"firstPurchaseId\":         211,\n    \"lastPurchaseId\":          1142,\n    \"firstPurchaseDate\":       \"2024-01-09T09:34:13-03:00\",\n    \"lastPurchaseDate\":        \"2026-04-22T17:48:00-03:00\",\n    \"averagePurchaseInterval\": 28.4,\n    \"totalPurchaseValue\":      398900,\n    \"totalPurchases\":          12,\n    \"daysWithoutPurchase\":     12,\n    \"lastRewardCardId\":        9821,\n    \"lastRewardCardDate\":      \"2026-04-22T17:48:03-03:00\",\n    \"nextUpdateDate\":          \"2026-05-04T03:00:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "Person has no purchase history yet",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{person}}/rfm",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{person}}",
                                                        "rfm"
                                                    ]
                                                },
                                                "description": "Returns the **R**ecency / **F**requency / **M**onetary record for a\nsingle person — first/last purchase, lifetime value, count, cadence,\nand the most recent reward card received. Refreshed automatically\nafter every order commit and whenever a reward card is issued.\n\nUsed by admin and segmentation flows to display a customer's\npurchasing snapshot. For listing many at once see\n[List RFM](/docs/{lang}/api-reference/register/customer/rfm/list)."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"not_found\", \"message\": \"rfm not found\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Tags",
                            "item": [
                                {
                                    "name": "Assign tags to a customer",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{personId}}/tags",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{personId}}",
                                                "tags"
                                            ]
                                        },
                                        "description": "Attaches one or more tags to a customer. The body is a **JSON array of tag\ninteger IDs**. For each tag: a `person_tag_history` row is recorded with\n`action = QUALIFIED` and the tag is inserted; if the link already exists, its\n`count` column is incremented (`ON DUPLICATE KEY UPDATE count = count + 1`).\n\nThe response is a flat list of *all* tag IDs currently attached to the customer.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "[101, 102, 103]",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated list of tag IDs attached to the customer.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{personId}}/tags",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{personId}}",
                                                        "tags"
                                                    ]
                                                },
                                                "description": "Attaches one or more tags to a customer. The body is a **JSON array of tag\ninteger IDs**. For each tag: a `person_tag_history` row is recorded with\n`action = QUALIFIED` and the tag is inserted; if the link already exists, its\n`count` column is incremented (`ON DUPLICATE KEY UPDATE count = count + 1`).\n\nThe response is a flat list of *all* tag IDs currently attached to the customer.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "[101, 102, 103]",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[1, 101, 102, 103]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove tags from a customer",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{personId}}/tags",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{personId}}",
                                                "tags"
                                            ]
                                        },
                                        "description": "Detaches one or more tags from a customer. The body is a **JSON array of tag\ninteger IDs**. For each tag a `person_tag_history` row is recorded with\n`action = REMOVED` and the link in `person_tag` is deleted. The response is a\nflat list of the tag IDs that *remain* attached to the customer.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "[101, 102]",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Remaining tag IDs after removal.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{personId}}/tags",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{personId}}",
                                                        "tags"
                                                    ]
                                                },
                                                "description": "Detaches one or more tags from a customer. The body is a **JSON array of tag\ninteger IDs**. For each tag a `person_tag_history` row is recorded with\n`action = REMOVED` and the link in `person_tag` is deleted. The response is a\nflat list of the tag IDs that *remain* attached to the customer.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "[101, 102]",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[1, 103]"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Tags",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/tags",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "{{id}}",
                                                "tags"
                                            ]
                                        },
                                        "description": "Returns the active tags of a customer as a paginated list of **tag IDs**.\n\nThe list includes the customer **lifecycle** stage — `5` (Lead), `6` (Customer)\nor `7` (Churn), assigned automatically. See the Customer Lifecycle guide. For the\nstage plus the churn forecast (`churnAt`), use the `lifecycle` object in\n[Get customer](/en-US/api-reference/register/customer/get)."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/{{id}}/tags",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "customer",
                                                        "{{id}}",
                                                        "tags"
                                                    ]
                                                },
                                                "description": "Returns the active tags of a customer as a paginated list of **tag IDs**.\n\nThe list includes the customer **lifecycle** stage — `5` (Lead), `6` (Customer)\nor `7` (Churn), assigned automatically. See the Customer Lifecycle guide. For the\nstage plus the churn forecast (`churnAt`), use the `lifecycle` object in\n[Get customer](/en-US/api-reference/register/customer/get)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [6, 2, 453, 90],\n    \"total\": 4,\n    \"pagination\": { \"entries\": 50, \"totalPages\": 1, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": true }\n}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Update customer",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer"
                                    ]
                                },
                                "description": "Updates a customer record. Only `id` is required; any other field present in the\nbody is updated, anything omitted is left untouched. Same sanitization as the\ncreate endpoint (phone via libphonenumber, email lower-cased, document stripped\nto alphanumeric).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 683752,\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"41236587422\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\",\n    \"optin\": \"2026-05-03T10:00:00-03:00\",\n    \"privacyAccepted\": \"2026-05-03T10:00:00-03:00\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Customer updated.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer"
                                            ]
                                        },
                                        "description": "Updates a customer record. Only `id` is required; any other field present in the\nbody is updated, anything omitted is left untouched. Same sanitization as the\ncreate endpoint (phone via libphonenumber, email lower-cased, document stripped\nto alphanumeric).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 683752,\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"41236587422\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\",\n    \"optin\": \"2026-05-03T10:00:00-03:00\",\n    \"privacyAccepted\": \"2026-05-03T10:00:00-03:00\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 683752,\n    \"name\": \"Tintin\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"document\": \"41236587422\",\n    \"gender\": \"male\",\n    \"postalCode\": \"13450000\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"language\": \"pt_BR\",\n    \"updatedAt\": \"2026-05-03T10:00:00-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Update customers in batch",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/customer/batch",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "customer",
                                        "batch"
                                    ]
                                },
                                "description": "Updates **many customers in one call** — a list of items, each with its `id`\nand the fields to change. Use it instead of looping the single update: setting\nthe same field on hundreds of customers (e.g. `entityType=legal`) or importing\nper-customer values all go in one request.\n\nEach item reuses the **exact same path as the single update** (same\nsanitization and validation; only `id` is required per item, anything omitted is\nleft untouched). A bad item does **not** fail the batch: the response reports an\n`outcome` per item — `updated`, `not_found`, or `rejected` (with the reason) —\nplus a `summary` of counts.\n\nPass **`dryRun: true`** to validate without writing: every eligible item comes\nback as `would_update` and nothing is changed. Up to **100 items** per call.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n  \"items\": [\n    { \"id\": 683752, \"entityType\": \"legal\" },\n    { \"id\": 683999, \"entityType\": \"legal\" },\n    { \"id\": 684010, \"name\": \"Tintin\", \"email\": \"tintim@guper.co\" }\n  ],\n  \"dryRun\": false\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Batch processed (per-item outcomes; individual failures do not fail the batch).",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/batch",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "batch"
                                            ]
                                        },
                                        "description": "Updates **many customers in one call** — a list of items, each with its `id`\nand the fields to change. Use it instead of looping the single update: setting\nthe same field on hundreds of customers (e.g. `entityType=legal`) or importing\nper-customer values all go in one request.\n\nEach item reuses the **exact same path as the single update** (same\nsanitization and validation; only `id` is required per item, anything omitted is\nleft untouched). A bad item does **not** fail the batch: the response reports an\n`outcome` per item — `updated`, `not_found`, or `rejected` (with the reason) —\nplus a `summary` of counts.\n\nPass **`dryRun: true`** to validate without writing: every eligible item comes\nback as `would_update` and nothing is changed. Up to **100 items** per call.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n  \"items\": [\n    { \"id\": 683752, \"entityType\": \"legal\" },\n    { \"id\": 683999, \"entityType\": \"legal\" },\n    { \"id\": 684010, \"name\": \"Tintin\", \"email\": \"tintim@guper.co\" }\n  ],\n  \"dryRun\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"dryRun\": false,\n  \"total\": 3,\n  \"summary\": { \"updated\": 2, \"notFound\": 1, \"rejected\": 0 },\n  \"results\": [\n    { \"id\": 683752, \"outcome\": \"updated\" },\n    { \"id\": 683999, \"outcome\": \"updated\" },\n    { \"id\": 684010, \"outcome\": \"not_found\" }\n  ]\n}"
                                },
                                {
                                    "name": "Malformed request: no `items`, more than 100, or an item without a numeric `id`.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/customer/batch",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "customer",
                                                "batch"
                                            ]
                                        },
                                        "description": "Updates **many customers in one call** — a list of items, each with its `id`\nand the fields to change. Use it instead of looping the single update: setting\nthe same field on hundreds of customers (e.g. `entityType=legal`) or importing\nper-customer values all go in one request.\n\nEach item reuses the **exact same path as the single update** (same\nsanitization and validation; only `id` is required per item, anything omitted is\nleft untouched). A bad item does **not** fail the batch: the response reports an\n`outcome` per item — `updated`, `not_found`, or `rejected` (with the reason) —\nplus a `summary` of counts.\n\nPass **`dryRun: true`** to validate without writing: every eligible item comes\nback as `would_update` and nothing is changed. Up to **100 items** per call.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n  \"items\": [\n    { \"id\": 683752, \"entityType\": \"legal\" },\n    { \"id\": 683999, \"entityType\": \"legal\" },\n    { \"id\": 684010, \"name\": \"Tintin\", \"email\": \"tintim@guper.co\" }\n  ],\n  \"dryRun\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Datacapture",
                    "item": [
                        {
                            "name": "Form",
                            "item": [
                                {
                                    "name": "Create data-capture form",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "form"
                                            ]
                                        },
                                        "description": "Defines a data-capture form template (e.g. opt-in/lead form). Each form is a\n`name` plus a list of `fields`. The form must include a field whose `name`\nmatches the organization's primary identifier (first column of `matchPattern`,\ntypically `cellphone` or `email`); that field is automatically marked as\n`required: true` and `identifier: true`.\n\nA field can also be flagged with `metadata: true` so its captured value is\nstored as **person metadata** (a custom key/value field) instead of being\ndropped. See the *Custom Fields* guide and the `custom-field` endpoints.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"optin\",\n    \"fields\": [\n        {\n            \"name\": \"name\",\n            \"label\": \"Nome\",\n            \"type\": \"text\",\n            \"required\": true,\n            \"metadata\": false,\n            \"metaKey\": \"shirt_size\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Form created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form"
                                                    ]
                                                },
                                                "description": "Defines a data-capture form template (e.g. opt-in/lead form). Each form is a\n`name` plus a list of `fields`. The form must include a field whose `name`\nmatches the organization's primary identifier (first column of `matchPattern`,\ntypically `cellphone` or `email`); that field is automatically marked as\n`required: true` and `identifier: true`.\n\nA field can also be flagged with `metadata: true` so its captured value is\nstored as **person metadata** (a custom key/value field) instead of being\ndropped. See the *Custom Fields* guide and the `custom-field` endpoints.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"optin\",\n    \"fields\": [\n        {\n            \"name\": \"name\",\n            \"label\": \"Nome\",\n            \"type\": \"text\",\n            \"required\": true,\n            \"metadata\": false,\n            \"metaKey\": \"shirt_size\"\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"name\": \"optin\",\n    \"fields\": [\n        { \"name\": \"name\",      \"label\": \"Nome\",     \"type\": \"text\",  \"required\": true },\n        { \"name\": \"email\",     \"label\": \"E-mail\",   \"type\": \"email\", \"required\": true, \"identifier\": true },\n        { \"name\": \"cellphone\", \"label\": \"Telefone\", \"type\": \"text\",  \"required\": false },\n        { \"name\": \"shirt_size\", \"label\": \"Tamanho\", \"type\": \"text\",  \"required\": false, \"metadata\": true, \"metaKey\": \"shirt_size\" }\n    ]\n}"
                                        },
                                        {
                                            "name": "Form does not include the organization identifier field.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form"
                                                    ]
                                                },
                                                "description": "Defines a data-capture form template (e.g. opt-in/lead form). Each form is a\n`name` plus a list of `fields`. The form must include a field whose `name`\nmatches the organization's primary identifier (first column of `matchPattern`,\ntypically `cellphone` or `email`); that field is automatically marked as\n`required: true` and `identifier: true`.\n\nA field can also be flagged with `metadata: true` so its captured value is\nstored as **person metadata** (a custom key/value field) instead of being\ndropped. See the *Custom Fields* guide and the `custom-field` endpoints.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"optin\",\n    \"fields\": [\n        {\n            \"name\": \"name\",\n            \"label\": \"Nome\",\n            \"type\": \"text\",\n            \"required\": true,\n            \"metadata\": false,\n            \"metaKey\": \"shirt_size\"\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Capture Form",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "form",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single data capture form with its fields."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single data capture form with its fields."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List Capture Forms",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "form"
                                            ]
                                        },
                                        "description": "Returns a paginated list of resources."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of resources."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove data-capture form",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "form"
                                            ]
                                        },
                                        "description": "Soft-deletes a data-capture form. The ID goes in the request body, not in the\nURL.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Form removed.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form"
                                                    ]
                                                },
                                                "description": "Soft-deletes a data-capture form. The ID goes in the request body, not in the\nURL.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Update data-capture form",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "form"
                                            ]
                                        },
                                        "description": "Updates a data-capture form definition. Only `id` is required; if `fields` is\nsent it goes through the same identifier-validation as on create — the\norganization's primary identifier field must be present and will be flagged as\n`required: true` and `identifier: true`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"name\": \"optin\",\n    \"fields\": [\n        {\n            \"name\": \"phone\",\n            \"label\": \"Telefone\",\n            \"type\": \"text\",\n            \"required\": false,\n            \"metadata\": false,\n            \"metaKey\": \"shirt_size\"\n        }\n    ]\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Form updated.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form"
                                                    ]
                                                },
                                                "description": "Updates a data-capture form definition. Only `id` is required; if `fields` is\nsent it goes through the same identifier-validation as on create — the\norganization's primary identifier field must be present and will be flagged as\n`required: true` and `identifier: true`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"name\": \"optin\",\n    \"fields\": [\n        {\n            \"name\": \"phone\",\n            \"label\": \"Telefone\",\n            \"type\": \"text\",\n            \"required\": false,\n            \"metadata\": false,\n            \"metaKey\": \"shirt_size\"\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "When `fields` is sent and does not include the organization identifier.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/form",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "form"
                                                    ]
                                                },
                                                "description": "Updates a data-capture form definition. Only `id` is required; if `fields` is\nsent it goes through the same identifier-validation as on create — the\norganization's primary identifier field must be present and will be flagged as\n`required: true` and `identifier: true`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"name\": \"optin\",\n    \"fields\": [\n        {\n            \"name\": \"phone\",\n            \"label\": \"Telefone\",\n            \"type\": \"text\",\n            \"required\": false,\n            \"metadata\": false,\n            \"metaKey\": \"shirt_size\"\n        }\n    ]\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Render Form",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/{{formID}}/render/{{sID}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "datacapture",
                                        "{{formID}}",
                                        "render",
                                        "{{sID}}"
                                    ]
                                },
                                "description": "Renders a configurable data-capture form (HTML) for a given submission session — typically embedded in storefront landing pages."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/{{formID}}/render/{{sID}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "{{formID}}",
                                                "render",
                                                "{{sID}}"
                                            ]
                                        },
                                        "description": "Renders a configurable data-capture form (HTML) for a given submission session — typically embedded in storefront landing pages."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"submissionKey\": \"xyz987654\",\n  \"fields\": [\n    { \n        \"name\": \"name\", \n        \"label\": \"Nome\", \n        \"type\": \"text\", \n        \"required\": true\n    },\n    { \n        \"name\": \"email\", \n        \"label\": \"E-mail\", \n        \"type\": \"email\", \n        \"required\": true\n    },\n    { \n        \"name\": \"phone\", \n        \"label\": \"Telefone\", \n        \"type\": \"text\", \n        \"required\": false\n    }\n  ]\n}"
                                }
                            ]
                        },
                        {
                            "name": "Source",
                            "item": [
                                {
                                    "name": "Create source ID",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "sid"
                                            ]
                                        },
                                        "description": "Registers a *Source ID* (SID) — a short alias used to track the origin of a\nsubmission (campaign, channel, physical placement, etc.). SIDs are paired with\na form ID at render time to produce a `submissionKey`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"alias\": \"outdoor\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Source ID created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "sid"
                                                    ]
                                                },
                                                "description": "Registers a *Source ID* (SID) — a short alias used to track the origin of a\nsubmission (campaign, channel, physical placement, etc.). SIDs are paired with\na form ID at render time to produce a `submissionKey`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"alias\": \"outdoor\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"alias\": \"outdoor\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Source",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "sid",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Request for registering people"
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "sid",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Request for registering people"
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List Sources",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "sid"
                                            ]
                                        },
                                        "description": "Returns a paginated list of resources."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "sid"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of resources."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove source ID",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "sid"
                                            ]
                                        },
                                        "description": "Soft-deletes a *Source ID*. The ID goes in the request body, not in the URL.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Source ID removed.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "sid"
                                                    ]
                                                },
                                                "description": "Soft-deletes a *Source ID*. The ID goes in the request body, not in the URL.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Update source ID",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "sid"
                                            ]
                                        },
                                        "description": "Updates a *Source ID* — typically just to rename the alias.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"alias\": \"outdoor\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Source ID updated.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/sid",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "datacapture",
                                                        "sid"
                                                    ]
                                                },
                                                "description": "Updates a *Source ID* — typically just to rename the alias.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"alias\": \"outdoor\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Submit data-capture form",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/datacapture/submit/{{submissionKey}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "datacapture",
                                        "submit",
                                        "{{submissionKey}}"
                                    ]
                                },
                                "description": "Submits the values entered in a previously rendered data-capture form.\n\nThe body is a **flat JSON object** whose keys match the form's field `name`s.\nThe value for the organization's identifier field (first column of\n`matchPattern` — usually `cellphone` or `email`) is required and must be\nunique within `(organization, formId, identifierValue)` — re-submitting the\nsame identifier on the same form returns HTTP 409.\n\nOn success the row is persisted in `register.formData` and the original\npayload is echoed back. Authentication is **not** required on this endpoint\n(the `submissionKey` itself is the credential — anyone holding it can submit).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Maria Oliveira\",\n    \"email\": \"maria@exemplo.com\",\n    \"cellphone\": \"+5511999999999\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Submission stored. Echoes the payload back.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/submit/{{submissionKey}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "submit",
                                                "{{submissionKey}}"
                                            ]
                                        },
                                        "description": "Submits the values entered in a previously rendered data-capture form.\n\nThe body is a **flat JSON object** whose keys match the form's field `name`s.\nThe value for the organization's identifier field (first column of\n`matchPattern` — usually `cellphone` or `email`) is required and must be\nunique within `(organization, formId, identifierValue)` — re-submitting the\nsame identifier on the same form returns HTTP 409.\n\nOn success the row is persisted in `register.formData` and the original\npayload is echoed back. Authentication is **not** required on this endpoint\n(the `submissionKey` itself is the credential — anyone holding it can submit).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Maria Oliveira\",\n    \"email\": \"maria@exemplo.com\",\n    \"cellphone\": \"+5511999999999\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"name\": \"Maria Oliveira\",\n    \"email\": \"maria@exemplo.com\",\n    \"cellphone\": \"+5511999999999\"\n}"
                                },
                                {
                                    "name": "Missing `submissionKey` or missing the organization identifier field in the body.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/submit/{{submissionKey}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "submit",
                                                "{{submissionKey}}"
                                            ]
                                        },
                                        "description": "Submits the values entered in a previously rendered data-capture form.\n\nThe body is a **flat JSON object** whose keys match the form's field `name`s.\nThe value for the organization's identifier field (first column of\n`matchPattern` — usually `cellphone` or `email`) is required and must be\nunique within `(organization, formId, identifierValue)` — re-submitting the\nsame identifier on the same form returns HTTP 409.\n\nOn success the row is persisted in `register.formData` and the original\npayload is echoed back. Authentication is **not** required on this endpoint\n(the `submissionKey` itself is the credential — anyone holding it can submit).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Maria Oliveira\",\n    \"email\": \"maria@exemplo.com\",\n    \"cellphone\": \"+5511999999999\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Duplicate — the identifier value has already been submitted on this form.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/datacapture/submit/{{submissionKey}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "datacapture",
                                                "submit",
                                                "{{submissionKey}}"
                                            ]
                                        },
                                        "description": "Submits the values entered in a previously rendered data-capture form.\n\nThe body is a **flat JSON object** whose keys match the form's field `name`s.\nThe value for the organization's identifier field (first column of\n`matchPattern` — usually `cellphone` or `email`) is required and must be\nunique within `(organization, formId, identifierValue)` — re-submitting the\nsame identifier on the same form returns HTTP 409.\n\nOn success the row is persisted in `register.formData` and the original\npayload is echoed back. Authentication is **not** required on this endpoint\n(the `submissionKey` itself is the credential — anyone holding it can submit).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Maria Oliveira\",\n    \"email\": \"maria@exemplo.com\",\n    \"cellphone\": \"+5511999999999\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 409,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Event",
                    "item": [
                        {
                            "name": "Search customers by event",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/event/search",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "event",
                                        "search"
                                    ]
                                },
                                "description": "Returns the **audience** (the list of customers) who have a recorded event in\n`person_event` of a given `type`, optionally narrowed by free-text terms and a\ndate window. This is the generic, event-based audience search — the same engine\nbehind the QON `event` filter, exposed as a simple `GET`.\n\nGeneric by `type`:\n\n- `type=buy_product` — customers who **bought a product**; `terms[]` match the\n  product name (`description`), **all terms ANDed** (substring, case- and\n  accent-insensitive). e.g. `terms[]=tennis&terms[]=preto` matches a customer who\n  bought *\"calçado tennis nike 42 preto e branco\"*.\n- `type=membership_joined` — customers who **joined** in the window; no `terms`\n  (membership events have no `description`).\n- any future event type (`abandoned_cart`, `app_open`, …) works the same way.\n\n`from`/`to` (`YYYY-MM-DD`) bound `occurredAt` (`to` is exclusive at the next day).\n\n**Scope:** this endpoint resolves the *event* criteria only. Demographic/behavioral\ncomposition (gender, age, RFM, tag, tier) is the audience builder's responsibility\nvia the QON `event` filter — see *Internal › Services › Register › Audiência por evento*.\n\nAuth: service-to-service RSA `signature` (see *Internal › Integração › Signature*).\nOrganization is taken from the request context.\n\n### Worked examples\n\nCustomers who bought a product whose name contains **\"tennis\" AND \"preto\"**, in 2026:\n\n```\nGET /api/register/event/search?type=buy_product&terms[]=tennis&terms[]=preto&from=2026-01-01&to=2026-07-01\n```\n\nCustomers who **joined membership** in the same window (no terms):\n\n```\nGET /api/register/event/search?type=membership_joined&from=2026-01-01&to=2026-07-01\n```\n\nResponse (`AudienceResult` — paginated; `entries=0` streams all rows):\n\n```json\n{\n    \"total\": 144262,\n    \"data\": [\n        { \"id\": 4293432, \"name\": \"John Doe\", \"email\": \"j@x.com\", \"gender\": \"male\" }\n    ],\n    \"pagination\": { \"entries\": 50, \"totalPages\": 2886, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": false }\n}\n```"
                            },
                            "response": [
                                {
                                    "name": "Audience (customers) matching the event criteria.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/event/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "event",
                                                "search"
                                            ]
                                        },
                                        "description": "Returns the **audience** (the list of customers) who have a recorded event in\n`person_event` of a given `type`, optionally narrowed by free-text terms and a\ndate window. This is the generic, event-based audience search — the same engine\nbehind the QON `event` filter, exposed as a simple `GET`.\n\nGeneric by `type`:\n\n- `type=buy_product` — customers who **bought a product**; `terms[]` match the\n  product name (`description`), **all terms ANDed** (substring, case- and\n  accent-insensitive). e.g. `terms[]=tennis&terms[]=preto` matches a customer who\n  bought *\"calçado tennis nike 42 preto e branco\"*.\n- `type=membership_joined` — customers who **joined** in the window; no `terms`\n  (membership events have no `description`).\n- any future event type (`abandoned_cart`, `app_open`, …) works the same way.\n\n`from`/`to` (`YYYY-MM-DD`) bound `occurredAt` (`to` is exclusive at the next day).\n\n**Scope:** this endpoint resolves the *event* criteria only. Demographic/behavioral\ncomposition (gender, age, RFM, tag, tier) is the audience builder's responsibility\nvia the QON `event` filter — see *Internal › Services › Register › Audiência por evento*.\n\nAuth: service-to-service RSA `signature` (see *Internal › Integração › Signature*).\nOrganization is taken from the request context.\n\n### Worked examples\n\nCustomers who bought a product whose name contains **\"tennis\" AND \"preto\"**, in 2026:\n\n```\nGET /api/register/event/search?type=buy_product&terms[]=tennis&terms[]=preto&from=2026-01-01&to=2026-07-01\n```\n\nCustomers who **joined membership** in the same window (no terms):\n\n```\nGET /api/register/event/search?type=membership_joined&from=2026-01-01&to=2026-07-01\n```\n\nResponse (`AudienceResult` — paginated; `entries=0` streams all rows):\n\n```json\n{\n    \"total\": 144262,\n    \"data\": [\n        { \"id\": 4293432, \"name\": \"John Doe\", \"email\": \"j@x.com\", \"gender\": \"male\" }\n    ],\n    \"pagination\": { \"entries\": 50, \"totalPages\": 2886, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": false }\n}\n```"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"total\": 144262,\n    \"data\": [\n        { \"id\": 4293432, \"name\": \"John Doe\", \"email\": \"j@x.com\", \"gender\": \"male\" }\n    ],\n    \"pagination\": { \"entries\": 50, \"totalPages\": 2886, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": false }\n}"
                                },
                                {
                                    "name": "`type` was not supplied.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/event/search",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "event",
                                                "search"
                                            ]
                                        },
                                        "description": "Returns the **audience** (the list of customers) who have a recorded event in\n`person_event` of a given `type`, optionally narrowed by free-text terms and a\ndate window. This is the generic, event-based audience search — the same engine\nbehind the QON `event` filter, exposed as a simple `GET`.\n\nGeneric by `type`:\n\n- `type=buy_product` — customers who **bought a product**; `terms[]` match the\n  product name (`description`), **all terms ANDed** (substring, case- and\n  accent-insensitive). e.g. `terms[]=tennis&terms[]=preto` matches a customer who\n  bought *\"calçado tennis nike 42 preto e branco\"*.\n- `type=membership_joined` — customers who **joined** in the window; no `terms`\n  (membership events have no `description`).\n- any future event type (`abandoned_cart`, `app_open`, …) works the same way.\n\n`from`/`to` (`YYYY-MM-DD`) bound `occurredAt` (`to` is exclusive at the next day).\n\n**Scope:** this endpoint resolves the *event* criteria only. Demographic/behavioral\ncomposition (gender, age, RFM, tag, tier) is the audience builder's responsibility\nvia the QON `event` filter — see *Internal › Services › Register › Audiência por evento*.\n\nAuth: service-to-service RSA `signature` (see *Internal › Integração › Signature*).\nOrganization is taken from the request context.\n\n### Worked examples\n\nCustomers who bought a product whose name contains **\"tennis\" AND \"preto\"**, in 2026:\n\n```\nGET /api/register/event/search?type=buy_product&terms[]=tennis&terms[]=preto&from=2026-01-01&to=2026-07-01\n```\n\nCustomers who **joined membership** in the same window (no terms):\n\n```\nGET /api/register/event/search?type=membership_joined&from=2026-01-01&to=2026-07-01\n```\n\nResponse (`AudienceResult` — paginated; `entries=0` streams all rows):\n\n```json\n{\n    \"total\": 144262,\n    \"data\": [\n        { \"id\": 4293432, \"name\": \"John Doe\", \"email\": \"j@x.com\", \"gender\": \"male\" }\n    ],\n    \"pagination\": { \"entries\": 50, \"totalPages\": 2886, \"currentPage\": 1, \"isInitial\": true, \"isEnd\": false }\n}\n```"
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"type is required\" }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Feedback",
                    "item": [
                        {
                            "name": "Category",
                            "item": [
                                {
                                    "name": "Create feedback category",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "category"
                                            ]
                                        },
                                        "description": "Creates a new feedback category. Use this to define the topics you want\ncustomers to evaluate (e.g. *delivery*, *product*, *attendance*). Categories\nare optional on reviews — only create the ones you actually plan to use.\n\n`slug` is unique per organization (`UNIQUE(organization, slug)`); attempting\nto reuse an existing slug returns a database conflict.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"delivery\",\n    \"name\": \"Delivery\",\n    \"description\": \"Evaluates the delivery experience.\",\n    \"active\": 1,\n    \"data\": \"<data>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Category created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Creates a new feedback category. Use this to define the topics you want\ncustomers to evaluate (e.g. *delivery*, *product*, *attendance*). Categories\nare optional on reviews — only create the ones you actually plan to use.\n\n`slug` is unique per organization (`UNIQUE(organization, slug)`); attempting\nto reuse an existing slug returns a database conflict.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"slug\": \"delivery\",\n    \"name\": \"Delivery\",\n    \"description\": \"Evaluates the delivery experience.\",\n    \"active\": 1,\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"slug\": \"delivery\",\n    \"name\": \"Delivery\",\n    \"description\": \"Evaluates the delivery experience.\",\n    \"active\": 1,\n    \"data\": null,\n    \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n    \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete feedback category",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "category"
                                            ]
                                        },
                                        "description": "Permanently deletes a feedback category. The foreign key from\n`feedback_review.categoryId` is `ON DELETE RESTRICT`, so the operation\nfails if any review still references the category. Prefer\n`PUT /feedback/category` with `active: 0` to retire a category that already\nhas reviews.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Category deleted.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Permanently deletes a feedback category. The foreign key from\n`feedback_review.categoryId` is `ON DELETE RESTRICT`, so the operation\nfails if any review still references the category. Prefer\n`PUT /feedback/category` with `active: 0` to retire a category that already\nhas reviews.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "Category is in use by one or more reviews — soft-retire it instead by setting `active: 0`.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Permanently deletes a feedback category. The foreign key from\n`feedback_review.categoryId` is `ON DELETE RESTRICT`, so the operation\nfails if any review still references the category. Prefer\n`PUT /feedback/category` with `active: 0` to retire a category that already\nhas reviews.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List feedback categories",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "category"
                                            ]
                                        },
                                        "description": "Lists feedback categories for the organization. Categories are an optional\ntaxonomy used to group reviews (e.g. *delivery*, *product*, *service*) — a\nreview may be uncategorized (`categoryId: null`) when the organization has\nnot adopted a catalog yet.\n\nSupports the standard `q[col][OP]=value` listing filters (see *List query\nparameters*). Common filters: `q[active][]=1`, `q[slug][]=delivery`."
                                    },
                                    "response": [
                                        {
                                            "name": "List of categories.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Lists feedback categories for the organization. Categories are an optional\ntaxonomy used to group reviews (e.g. *delivery*, *product*, *service*) — a\nreview may be uncategorized (`categoryId: null`) when the organization has\nnot adopted a catalog yet.\n\nSupports the standard `q[col][OP]=value` listing filters (see *List query\nparameters*). Common filters: `q[active][]=1`, `q[slug][]=delivery`."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"total\": 2,\n    \"page\": 1,\n    \"rowsPerPage\": 20,\n    \"list\": [\n        {\n            \"id\": 1,\n            \"slug\": \"delivery\",\n            \"name\": \"Delivery\",\n            \"description\": \"Evaluates the delivery experience.\",\n            \"active\": 1,\n            \"data\": null,\n            \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n            \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n        },\n        {\n            \"id\": 2,\n            \"slug\": \"product\",\n            \"name\": \"Product\",\n            \"description\": null,\n            \"active\": 1,\n            \"data\": null,\n            \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n            \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n        }\n    ]\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get feedback category",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/category/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "category",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single feedback category by its numeric `id`. Returns `404` when\nthe id does not exist in the requesting organization."
                                    },
                                    "response": [
                                        {
                                            "name": "Category found.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single feedback category by its numeric `id`. Returns `404` when\nthe id does not exist in the requesting organization."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"slug\": \"delivery\",\n    \"name\": \"Delivery\",\n    \"description\": \"Evaluates the delivery experience.\",\n    \"active\": 1,\n    \"data\": null,\n    \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n    \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "Category not found in this organization.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single feedback category by its numeric `id`. Returns `404` when\nthe id does not exist in the requesting organization."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Update feedback category",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "category"
                                            ]
                                        },
                                        "description": "Updates an existing feedback category. The `id` is required in the body;\nany other supplied field is overwritten. Categories cannot be deleted while\nthey are referenced by at least one review — set `active: 0` to retire them\nsoftly instead.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"slug\": \"delivery\",\n    \"name\": \"Delivery\",\n    \"description\": \"Updated description.\",\n    \"active\": 0,\n    \"data\": \"<data>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Category updated.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/category",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "category"
                                                    ]
                                                },
                                                "description": "Updates an existing feedback category. The `id` is required in the body;\nany other supplied field is overwritten. Categories cannot be deleted while\nthey are referenced by at least one review — set `active: 0` to retire them\nsoftly instead.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"slug\": \"delivery\",\n    \"name\": \"Delivery\",\n    \"description\": \"Updated description.\",\n    \"active\": 0,\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Review",
                            "item": [
                                {
                                    "name": "Create feedback review",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/review",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "review"
                                            ]
                                        },
                                        "description": "Records a customer review for a specific order. Exactly **one** review per\norder is allowed — a second `POST` for the same `orderId` returns `409`.\n\nThe review carries a `type` discriminator that tells which scale the\n`rating` follows:\n\n- `type: csat` — rating from **1 to 5** (Customer Satisfaction)\n- `type: nps`  — rating from **0 to 10** (Net Promoter Score)\n\n`comment` is always required (free-form text, must not be empty after\n`trim`). `categoryId` is optional — supply it only if the organization has\ncreated the corresponding category beforehand. When omitted, the review is\nuncategorized.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"categoryId\": 1,\n    \"source\": \"journey\",\n    \"data\": \"<data>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Review created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review"
                                                    ]
                                                },
                                                "description": "Records a customer review for a specific order. Exactly **one** review per\norder is allowed — a second `POST` for the same `orderId` returns `409`.\n\nThe review carries a `type` discriminator that tells which scale the\n`rating` follows:\n\n- `type: csat` — rating from **1 to 5** (Customer Satisfaction)\n- `type: nps`  — rating from **0 to 10** (Net Promoter Score)\n\n`comment` is always required (free-form text, must not be empty after\n`trim`). `categoryId` is optional — supply it only if the organization has\ncreated the corresponding category beforehand. When omitted, the review is\nuncategorized.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"categoryId\": 1,\n    \"source\": \"journey\",\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"categoryId\": 1,\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"source\": \"journey\",\n    \"data\": null,\n    \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n    \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "Validation error — invalid `type`, `rating` out of range for the chosen `type`, empty `comment`, or `categoryId` does not belong to this organization.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review"
                                                    ]
                                                },
                                                "description": "Records a customer review for a specific order. Exactly **one** review per\norder is allowed — a second `POST` for the same `orderId` returns `409`.\n\nThe review carries a `type` discriminator that tells which scale the\n`rating` follows:\n\n- `type: csat` — rating from **1 to 5** (Customer Satisfaction)\n- `type: nps`  — rating from **0 to 10** (Net Promoter Score)\n\n`comment` is always required (free-form text, must not be empty after\n`trim`). `categoryId` is optional — supply it only if the organization has\ncreated the corresponding category beforehand. When omitted, the review is\nuncategorized.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"categoryId\": 1,\n    \"source\": \"journey\",\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "A review already exists for this order. Use `PUT /feedback/review/{id}` to amend instead.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review"
                                                    ]
                                                },
                                                "description": "Records a customer review for a specific order. Exactly **one** review per\norder is allowed — a second `POST` for the same `orderId` returns `409`.\n\nThe review carries a `type` discriminator that tells which scale the\n`rating` follows:\n\n- `type: csat` — rating from **1 to 5** (Customer Satisfaction)\n- `type: nps`  — rating from **0 to 10** (Net Promoter Score)\n\n`comment` is always required (free-form text, must not be empty after\n`trim`). `categoryId` is optional — supply it only if the organization has\ncreated the corresponding category beforehand. When omitted, the review is\nuncategorized.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"categoryId\": 1,\n    \"source\": \"journey\",\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete feedback review",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "review",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Permanently removes a review by id. Intended for administrative moderation\n(e.g. spam, mis-tagged orders) — the regular customer flow should not\nexpose this endpoint."
                                    },
                                    "response": [
                                        {
                                            "name": "Review deleted.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Permanently removes a review by id. Intended for administrative moderation\n(e.g. spam, mis-tagged orders) — the regular customer flow should not\nexpose this endpoint."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "Review not found in this organization.",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Permanently removes a review by id. Intended for administrative moderation\n(e.g. spam, mis-tagged orders) — the regular customer flow should not\nexpose this endpoint."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List feedback reviews",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/review",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "review"
                                            ]
                                        },
                                        "description": "Lists per-order feedback reviews. Supports the standard `q[col][OP]=value`\nlisting filters (see *List query parameters*). Useful filters:\n\n- `q[type][]=csat` or `q[type][]=nps`\n- `q[rating][GTE]=4` — promoters/satisfied customers\n- `q[rating][LTE]=2` — detractors\n- `q[personId][]=12345` — all reviews from a customer\n- `q[categoryId][]=3` — by category"
                                    },
                                    "response": [
                                        {
                                            "name": "List of reviews.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review"
                                                    ]
                                                },
                                                "description": "Lists per-order feedback reviews. Supports the standard `q[col][OP]=value`\nlisting filters (see *List query parameters*). Useful filters:\n\n- `q[type][]=csat` or `q[type][]=nps`\n- `q[rating][GTE]=4` — promoters/satisfied customers\n- `q[rating][LTE]=2` — detractors\n- `q[personId][]=12345` — all reviews from a customer\n- `q[categoryId][]=3` — by category"
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"total\": 2,\n    \"page\": 1,\n    \"rowsPerPage\": 20,\n    \"list\": [\n        {\n            \"id\": 1,\n            \"personId\": 12345,\n            \"orderId\": \"ORD-789\",\n            \"type\": \"csat\",\n            \"categoryId\": 1,\n            \"rating\": 5,\n            \"comment\": \"Great delivery, on time and well packaged.\",\n            \"source\": \"journey\",\n            \"data\": null,\n            \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n            \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n        },\n        {\n            \"id\": 2,\n            \"personId\": 67890,\n            \"orderId\": \"ORD-790\",\n            \"type\": \"nps\",\n            \"categoryId\": null,\n            \"rating\": 10,\n            \"comment\": \"Would definitely recommend.\",\n            \"source\": \"journey\",\n            \"data\": null,\n            \"createdAt\": \"2026-05-14T11:05:00-03:00\",\n            \"updatedAt\": \"2026-05-14T11:05:00-03:00\"\n        }\n    ]\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get feedback review",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "review",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single feedback review by its numeric `id`. Returns `404` when\nthe id does not exist in the requesting organization."
                                    },
                                    "response": [
                                        {
                                            "name": "Review found.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single feedback review by its numeric `id`. Returns `404` when\nthe id does not exist in the requesting organization."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"categoryId\": 1,\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"source\": \"journey\",\n    \"data\": null,\n    \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n    \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "Review not found in this organization.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single feedback review by its numeric `id`. Returns `404` when\nthe id does not exist in the requesting organization."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Get feedback review by order",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/byOrder/{{orderId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "review",
                                                "byOrder",
                                                "{{orderId}}"
                                            ]
                                        },
                                        "description": "Returns the review attached to a given `orderId`. Because the schema\nenforces `UNIQUE(organization, orderId)`, this lookup always returns at\nmost one review.\n\nUseful in flows that want to check *whether* a customer has already\nreviewed a given order before sending an invitation — a `404` means the\norder has no review yet."
                                    },
                                    "response": [
                                        {
                                            "name": "Review found.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/byOrder/{{orderId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "byOrder",
                                                        "{{orderId}}"
                                                    ]
                                                },
                                                "description": "Returns the review attached to a given `orderId`. Because the schema\nenforces `UNIQUE(organization, orderId)`, this lookup always returns at\nmost one review.\n\nUseful in flows that want to check *whether* a customer has already\nreviewed a given order before sending an invitation — a `404` means the\norder has no review yet."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"personId\": 12345,\n    \"orderId\": \"ORD-789\",\n    \"type\": \"csat\",\n    \"categoryId\": 1,\n    \"rating\": 5,\n    \"comment\": \"Great delivery, on time and well packaged.\",\n    \"source\": \"journey\",\n    \"data\": null,\n    \"createdAt\": \"2026-05-14T11:00:00-03:00\",\n    \"updatedAt\": \"2026-05-14T11:00:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "No review yet for this order.",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/byOrder/{{orderId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "byOrder",
                                                        "{{orderId}}"
                                                    ]
                                                },
                                                "description": "Returns the review attached to a given `orderId`. Because the schema\nenforces `UNIQUE(organization, orderId)`, this lookup always returns at\nmost one review.\n\nUseful in flows that want to check *whether* a customer has already\nreviewed a given order before sending an invitation — a `404` means the\norder has no review yet."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Update feedback review",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "feedback",
                                                "review",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates an existing review by id. Only the fields you send are touched —\neverything else stays as it was.\n\nSwitching `type` mid-stream is allowed but the resulting `rating` must\nstill fall in the new range:\n\n- if you change `type` from `csat` to `nps`, the existing rating (1..5)\n  stays valid (still inside 0..10), but you may also send a higher rating.\n- if you change from `nps` to `csat` and the existing rating is `6..10`,\n  you **must** send a new rating in the 1..5 range or the request is\n  rejected with `400`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"type\": \"nps\",\n    \"rating\": 9,\n    \"comment\": \"Updated feedback after the carrier reached out.\",\n    \"categoryId\": 2,\n    \"data\": \"<data>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Review updated.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Updates an existing review by id. Only the fields you send are touched —\neverything else stays as it was.\n\nSwitching `type` mid-stream is allowed but the resulting `rating` must\nstill fall in the new range:\n\n- if you change `type` from `csat` to `nps`, the existing rating (1..5)\n  stays valid (still inside 0..10), but you may also send a higher rating.\n- if you change from `nps` to `csat` and the existing rating is `6..10`,\n  you **must** send a new rating in the 1..5 range or the request is\n  rejected with `400`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"type\": \"nps\",\n    \"rating\": 9,\n    \"comment\": \"Updated feedback after the carrier reached out.\",\n    \"categoryId\": 2,\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "Validation error — invalid `type`, rating outside the resulting range, empty `comment`, or `categoryId` does not belong to this organization.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Updates an existing review by id. Only the fields you send are touched —\neverything else stays as it was.\n\nSwitching `type` mid-stream is allowed but the resulting `rating` must\nstill fall in the new range:\n\n- if you change `type` from `csat` to `nps`, the existing rating (1..5)\n  stays valid (still inside 0..10), but you may also send a higher rating.\n- if you change from `nps` to `csat` and the existing rating is `6..10`,\n  you **must** send a new rating in the 1..5 range or the request is\n  rejected with `400`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"type\": \"nps\",\n    \"rating\": 9,\n    \"comment\": \"Updated feedback after the carrier reached out.\",\n    \"categoryId\": 2,\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        },
                                        {
                                            "name": "Review not found in this organization.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/feedback/review/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "feedback",
                                                        "review",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Updates an existing review by id. Only the fields you send are touched —\neverything else stays as it was.\n\nSwitching `type` mid-stream is allowed but the resulting `rating` must\nstill fall in the new range:\n\n- if you change `type` from `csat` to `nps`, the existing rating (1..5)\n  stays valid (still inside 0..10), but you may also send a higher rating.\n- if you change from `nps` to `csat` and the existing rating is `6..10`,\n  you **must** send a new rating in the 1..5 range or the request is\n  rejected with `400`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"type\": \"nps\",\n    \"rating\": 9,\n    \"comment\": \"Updated feedback after the carrier reached out.\",\n    \"categoryId\": 2,\n    \"data\": \"<data>\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Membership",
                    "item": [
                        {
                            "name": "Active at",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/active-at",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "membership",
                                        "{{personId}}",
                                        "active-at"
                                    ]
                                },
                                "description": "Tells whether a person was an active member of a tier program at a given point in time.\nUseful when you need to gate a feature, award, or message by the membership state at the date of an event (e.g. order placed at).\n\nA member is \"active at `date`\" when:\n`joinedAt <= date AND (leftAt IS NULL OR date < leftAt)`.\n\nThe `tierConfig` can be provided directly, or resolved indirectly from a tag (the tag must be listed in `tag_tier_filter` for the organization)."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/active-at",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership",
                                                "{{personId}}",
                                                "active-at"
                                            ]
                                        },
                                        "description": "Tells whether a person was an active member of a tier program at a given point in time.\nUseful when you need to gate a feature, award, or message by the membership state at the date of an event (e.g. order placed at).\n\nA member is \"active at `date`\" when:\n`joinedAt <= date AND (leftAt IS NULL OR date < leftAt)`.\n\nThe `tierConfig` can be provided directly, or resolved indirectly from a tag (the tag must be listed in `tag_tier_filter` for the organization)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"person\":     4131293,\n    \"tierConfig\": 1,\n    \"date\":       \"2026-04-28T03:51:13+00:00\",\n    \"active\":     false\n}"
                                },
                                {
                                    "name": "Missing tierConfig or tag query parameter.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/active-at",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership",
                                                "{{personId}}",
                                                "active-at"
                                            ]
                                        },
                                        "description": "Tells whether a person was an active member of a tier program at a given point in time.\nUseful when you need to gate a feature, award, or message by the membership state at the date of an event (e.g. order placed at).\n\nA member is \"active at `date`\" when:\n`joinedAt <= date AND (leftAt IS NULL OR date < leftAt)`.\n\nThe `tierConfig` can be provided directly, or resolved indirectly from a tag (the tag must be listed in `tag_tier_filter` for the organization)."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Join",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/membership",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "membership"
                                    ]
                                },
                                "description": "Records a person joining (or rejoining) a tier program.\n\nMost memberships are created automatically by the tag hook: assigning a person a tag that is listed in `tag_tier_filter` triggers a join. This endpoint covers cases where the membership must be created manually (e.g. admin action, data import, special enrollment flow).\n\n**Idempotent**:\n- If no row exists → INSERT, history `joined`.\n- If row exists and is active (`leftAt IS NULL`) → no-op.\n- If row exists and was closed (`leftAt IS NOT NULL`) → clears `leftAt`, updates `joinedAt`, history `rejoined`.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"person\": 4131293,\n    \"tierConfig\": 1,\n    \"joinedAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Joined / Rejoined / No-op",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership"
                                            ]
                                        },
                                        "description": "Records a person joining (or rejoining) a tier program.\n\nMost memberships are created automatically by the tag hook: assigning a person a tag that is listed in `tag_tier_filter` triggers a join. This endpoint covers cases where the membership must be created manually (e.g. admin action, data import, special enrollment flow).\n\n**Idempotent**:\n- If no row exists → INSERT, history `joined`.\n- If row exists and is active (`leftAt IS NULL`) → no-op.\n- If row exists and was closed (`leftAt IS NOT NULL`) → clears `leftAt`, updates `joinedAt`, history `rejoined`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 4131293,\n    \"tierConfig\": 1,\n    \"joinedAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"action\": \"joined\" }"
                                },
                                {
                                    "name": "Already active",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership"
                                            ]
                                        },
                                        "description": "Records a person joining (or rejoining) a tier program.\n\nMost memberships are created automatically by the tag hook: assigning a person a tag that is listed in `tag_tier_filter` triggers a join. This endpoint covers cases where the membership must be created manually (e.g. admin action, data import, special enrollment flow).\n\n**Idempotent**:\n- If no row exists → INSERT, history `joined`.\n- If row exists and is active (`leftAt IS NULL`) → no-op.\n- If row exists and was closed (`leftAt IS NOT NULL`) → clears `leftAt`, updates `joinedAt`, history `rejoined`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 4131293,\n    \"tierConfig\": 1,\n    \"joinedAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"action\": \"noop\" }"
                                },
                                {
                                    "name": "Re-enrolled after leaving",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership"
                                            ]
                                        },
                                        "description": "Records a person joining (or rejoining) a tier program.\n\nMost memberships are created automatically by the tag hook: assigning a person a tag that is listed in `tag_tier_filter` triggers a join. This endpoint covers cases where the membership must be created manually (e.g. admin action, data import, special enrollment flow).\n\n**Idempotent**:\n- If no row exists → INSERT, history `joined`.\n- If row exists and is active (`leftAt IS NULL`) → no-op.\n- If row exists and was closed (`leftAt IS NOT NULL`) → clears `leftAt`, updates `joinedAt`, history `rejoined`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 4131293,\n    \"tierConfig\": 1,\n    \"joinedAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"action\": \"rejoined\" }"
                                },
                                {
                                    "name": "Missing required field.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership"
                                            ]
                                        },
                                        "description": "Records a person joining (or rejoining) a tier program.\n\nMost memberships are created automatically by the tag hook: assigning a person a tag that is listed in `tag_tier_filter` triggers a join. This endpoint covers cases where the membership must be created manually (e.g. admin action, data import, special enrollment flow).\n\n**Idempotent**:\n- If no row exists → INSERT, history `joined`.\n- If row exists and is active (`leftAt IS NULL`) → no-op.\n- If row exists and was closed (`leftAt IS NOT NULL`) → clears `leftAt`, updates `joinedAt`, history `rejoined`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 4131293,\n    \"tierConfig\": 1,\n    \"joinedAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Leave",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/{{tierConfig}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "membership",
                                        "{{personId}}",
                                        "{{tierConfig}}"
                                    ]
                                },
                                "description": "Closes an active membership by setting `leftAt`.\n\nMost \"leaves\" happen automatically: removing a person tag that is listed in `tag_tier_filter` triggers a leave via the tag hook. This endpoint covers manual or programmatic leaves (admin opt-out, account closure, special workflow).\n\n**Idempotent**:\n- No row, or row already has `leftAt` → no-op.\n- Active row → UPDATE sets `leftAt`, history `left`.\n\nThe membership row is **kept** (not deleted) so the historical timeline remains queryable.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"leftAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Left",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/{{tierConfig}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership",
                                                "{{personId}}",
                                                "{{tierConfig}}"
                                            ]
                                        },
                                        "description": "Closes an active membership by setting `leftAt`.\n\nMost \"leaves\" happen automatically: removing a person tag that is listed in `tag_tier_filter` triggers a leave via the tag hook. This endpoint covers manual or programmatic leaves (admin opt-out, account closure, special workflow).\n\n**Idempotent**:\n- No row, or row already has `leftAt` → no-op.\n- Active row → UPDATE sets `leftAt`, history `left`.\n\nThe membership row is **kept** (not deleted) so the historical timeline remains queryable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"leftAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"action\": \"left\" }"
                                },
                                {
                                    "name": "Already inactive (or never a member)",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/{{tierConfig}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership",
                                                "{{personId}}",
                                                "{{tierConfig}}"
                                            ]
                                        },
                                        "description": "Closes an active membership by setting `leftAt`.\n\nMost \"leaves\" happen automatically: removing a person tag that is listed in `tag_tier_filter` triggers a leave via the tag hook. This endpoint covers manual or programmatic leaves (admin opt-out, account closure, special workflow).\n\n**Idempotent**:\n- No row, or row already has `leftAt` → no-op.\n- Active row → UPDATE sets `leftAt`, history `left`.\n\nThe membership row is **kept** (not deleted) so the historical timeline remains queryable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"leftAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"action\": \"noop\" }"
                                },
                                {
                                    "name": "Missing personId or tierConfig.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}/{{tierConfig}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership",
                                                "{{personId}}",
                                                "{{tierConfig}}"
                                            ]
                                        },
                                        "description": "Closes an active membership by setting `leftAt`.\n\nMost \"leaves\" happen automatically: removing a person tag that is listed in `tag_tier_filter` triggers a leave via the tag hook. This endpoint covers manual or programmatic leaves (admin opt-out, account closure, special workflow).\n\n**Idempotent**:\n- No row, or row already has `leftAt` → no-op.\n- Active row → UPDATE sets `leftAt`, history `left`.\n\nThe membership row is **kept** (not deleted) so the historical timeline remains queryable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"leftAt\": \"2026-05-27T10:00:00-03:00\",\n    \"source\": \"manual\",\n    \"sourceRef\": \"admin:42\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Customer loyalty-program memberships",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "membership",
                                        "{{personId}}"
                                    ]
                                },
                                "description": "Whether a customer is a **member / associate** of a loyalty program and since\nwhen. Returns every membership of ONE person inside the\norganization — active (no `leftAt`) and historical (with `leftAt`). A person can\nbelong to more than one tier program; one row per `tierConfig`.\n\nThis is **per-customer** (`membership` is the source of truth for \"is this person\nan associate\"; the membership tag is only a mirror). It does **not** aggregate:\nfor org-wide numbers (how many members, revenue from members, member-to-buyer\nconversion) there is no report endpoint yet — that needs a direct query. Use\n`active-at` to know if the person was a member on a given date."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/membership/{{personId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "membership",
                                                "{{personId}}"
                                            ]
                                        },
                                        "description": "Whether a customer is a **member / associate** of a loyalty program and since\nwhen. Returns every membership of ONE person inside the\norganization — active (no `leftAt`) and historical (with `leftAt`). A person can\nbelong to more than one tier program; one row per `tierConfig`.\n\nThis is **per-customer** (`membership` is the source of truth for \"is this person\nan associate\"; the membership tag is only a mirror). It does **not** aggregate:\nfor org-wide numbers (how many members, revenue from members, member-to-buyer\nconversion) there is no report endpoint yet — that needs a direct query. Use\n`active-at` to know if the person was a member on a given date."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "[\n    {\n        \"tierConfig\": 1,\n        \"joinedAt\":   \"2026-04-28 01:14:27\",\n        \"leftAt\":     null,\n        \"isActive\":   true,\n        \"source\":     \"tag_hook\",\n        \"sourceRef\":  \"546\"\n    },\n    {\n        \"tierConfig\": 2,\n        \"joinedAt\":   \"2025-09-10 17:02:00\",\n        \"leftAt\":     \"2026-03-15 09:30:00\",\n        \"isActive\":   false,\n        \"source\":     \"manual\",\n        \"sourceRef\":  \"admin:42\"\n    }\n]"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Payment",
                    "item": [
                        {
                            "name": "By-entity",
                            "item": [
                                {
                                    "name": "List refs of a Payment",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/payment-external-ref/by-payment/{{paymentId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "payment-external-ref",
                                                "by-payment",
                                                "{{paymentId}}"
                                            ]
                                        },
                                        "description": "Lists every external `refId` mapped to one payment, one row per `source` (interface).\n\nReverse of `/api/register/{interface}/payment/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the payment has no mapping. Does not 404 on an unknown id."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/payment-external-ref/by-payment/{{paymentId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "payment-external-ref",
                                                        "by-payment",
                                                        "{{paymentId}}"
                                                    ]
                                                },
                                                "description": "Lists every external `refId` mapped to one payment, one row per `source` (interface).\n\nReverse of `/api/register/{interface}/payment/{refId}`: that one goes refId -> entity,\nthis one goes entity -> refIds. Mirrors `/api/register/person-external-ref/by-person/{personId}`.\n\nReturns an empty array when the payment has no mapping. Does not 404 on an unknown id."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"refId\":\"VTEX-001\",\"source\":\"vtex\"},{\"refId\":\"11-2\",\"source\":\"pos\"}]"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "By-interface",
                            "item": [
                                {
                                    "name": "Link Payment ref to existing entity",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "payment",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Links this `refId` to an existing entity (passed by `paymentId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"paymentId\": 42\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "payment",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Links this `refId` to an existing entity (passed by `paymentId`). Idempotent: if the ref already points to the same entity, no-op. If it pointed to a different entity, overwrites (PUT semantics). Returns 404 if the entity does not exist in the org.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"paymentId\": 42\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_linked\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Payment refs",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "payment"
                                            ]
                                        },
                                        "description": "Lists every external ref for `payment` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "payment"
                                                    ]
                                                },
                                                "description": "Lists every external ref for `payment` mapped under the given `{interface}` (e.g. `vtex`, `shopify`, `cegid`) for the org. Returns each ref's entity id, name and `_ref` metadata."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}},{\"id\":89,\"name\":\"Adidas\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-ADIDAS-001\"}}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Payment by ref",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "payment",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "payment",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Reads the entity linked to this `refId` under the `{interface}`. Returns 404 if no ref exists. Pure read - does not create anything."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"}}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove Payment ref",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "payment",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "payment",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Removes only the external ref. The underlying entity is NOT deleted (use the canonical entity DELETE for that). Returns 404 if the ref does not exist."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"success\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Bulk resolve Payment refs",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/_resolve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "payment",
                                                "_resolve"
                                            ]
                                        },
                                        "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment/_resolve",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "payment",
                                                        "_resolve"
                                                    ]
                                                },
                                                "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> entityId | null`. Up to 500 refIds per request. Optimized for the order processing hot path (single SQL with IN vs N round-trips).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"(array of strings)\": \"[\\\"VTEX-NIKE-001\\\", \\\"VTEX-ADIDAS-001\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"VTEX-NIKE-001\":42,\"VTEX-ADIDAS-001\":89,\"FAKE-DOES-NOT-EXIST\":null}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Create or get Payment ref",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "payment"
                                            ]
                                        },
                                        "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/payment",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "payment"
                                                    ]
                                                },
                                                "description": "Find-or-create: if a ref with this `refId` already exists for the interface, returns the linked entity (no-op, `_created: false`). Otherwise creates a new entity with the given `name` AND the external ref pointing to it (`_created: true`). Idempotent on retry.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"refId\": \"VTEX-NIKE-001\",\n    \"name\": \"Nike\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":42,\"name\":\"Nike\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"VTEX-NIKE-001\"},\"_created\":true}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Create payment method",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/payment",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "payment"
                                    ]
                                },
                                "description": "Registers a payment method (`register.payment` row) for the organization. The\ncontroller accepts both the canonical field names (`id`, `name`, `type`) and\ntheir VTEX-style aliases (`paymentSystem`, `paymentSystemName`,\n`paymentSystemType`); aliases win when both are sent. When `name`/`type` are\nomitted the values default to `UNNAMED`/`UNTYPED`.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": \"1\",\n    \"name\": \"Pix\",\n    \"type\": \"pix\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Payment method created.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/payment",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "payment"
                                            ]
                                        },
                                        "description": "Registers a payment method (`register.payment` row) for the organization. The\ncontroller accepts both the canonical field names (`id`, `name`, `type`) and\ntheir VTEX-style aliases (`paymentSystem`, `paymentSystemName`,\n`paymentSystemType`); aliases win when both are sent. When `name`/`type` are\nomitted the values default to `UNNAMED`/`UNTYPED`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": \"1\",\n    \"name\": \"Pix\",\n    \"type\": \"pix\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": \"1\",\n    \"name\": \"Pix\",\n    \"type\": \"pix\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Person",
                    "item": [
                        {
                            "name": "By-interface",
                            "item": [
                                {
                                    "name": "Link person ref (by role)",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "person",
                                                "{{role}}",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Links this `refId` + `{role}` to an existing person (passed by `personId`). Idempotent. Returns 404 if the person does not exist in the org. Persons are NOT created via external_ref - they must already exist (use register customer/person endpoints to create).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"personId\": 620977\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "person",
                                                        "{{role}}",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Links this `refId` + `{role}` to an existing person (passed by `personId`). Idempotent. Returns 404 if the person does not exist in the org. Persons are NOT created via external_ref - they must already exist (use register customer/person endpoints to create).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"personId\": 620977\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":620977,\"name\":\"Alice\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"99\",\"role\":\"cashier\"},\"_linked\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List person refs (by role)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "person",
                                                "{{role}}"
                                            ]
                                        },
                                        "description": "Lists every external person ref for the given `{role}` (cashier/salesperson/manager/client) under the `{interface}`. Returns each ref's personId, name and `_ref` metadata (including role)."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "person",
                                                        "{{role}}"
                                                    ]
                                                },
                                                "description": "Lists every external person ref for the given `{role}` (cashier/salesperson/manager/client) under the `{interface}`. Returns each ref's personId, name and `_ref` metadata (including role)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[{\"id\":620977,\"name\":\"Alice\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"99\",\"role\":\"cashier\"}},{\"id\":620980,\"name\":\"Bob\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"100\",\"role\":\"cashier\"}}]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get person ref (by role)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "person",
                                                "{{role}}",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Reads the person linked to this `refId` for the given `{role}` under the `{interface}`. Returns 404 if no ref exists for that combination. Roles are independent: the same `refId` can resolve to different persons in different roles."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "person",
                                                        "{{role}}",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Reads the person linked to this `refId` for the given `{role}` under the `{interface}`. Returns 404 if no ref exists for that combination. Roles are independent: the same `refId` can resolve to different persons in different roles."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"id\":620977,\"name\":\"Alice\",\"_ref\":{\"source\":\"vtex\",\"refId\":\"99\",\"role\":\"cashier\"}}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove person ref (by role)",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "person",
                                                "{{role}}",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Removes only this `refId` + `{role}` external ref. The underlying person is NOT deleted. Other roles for the same refId are unaffected."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "person",
                                                        "{{role}}",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Removes only this `refId` + `{role}` external ref. The underlying person is NOT deleted. Other roles for the same refId are unaffected."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"success\":true}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Bulk resolve person refs (by role)",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/_resolve",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "{{interface}}",
                                                "person",
                                                "{{role}}",
                                                "_resolve"
                                            ]
                                        },
                                        "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> personId | null` for the given `{role}`. Up to 500 refIds. Optimized for order/translate hot paths.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"(array of strings)\": \"[\\\"99\\\", \\\"100\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/{{interface}}/person/{{role}}/_resolve",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "{{interface}}",
                                                        "person",
                                                        "{{role}}",
                                                        "_resolve"
                                                    ]
                                                },
                                                "description": "Bulk lookup: pass a JSON array of refIds, get back a map `refId -> personId | null` for the given `{role}`. Up to 500 refIds. Optimized for order/translate hot paths.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"(array of strings)\": \"[\\\"99\\\", \\\"100\\\", \\\"FAKE-DOES-NOT-EXIST\\\"]\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\"99\":620977,\"100\":620980,\"FAKE-DOES-NOT-EXIST\":null}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Create person",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person"
                                    ]
                                },
                                "description": "Creates a record in `register.person` **without** flagging it as customer, user\nor collaborator (none of `isCustomer`/`isUser`/`isCollaborator` is set). Use\nthis when you just want a generic identity in the directory; for customer-only\nrows use `POST /api/register/customer` instead.\n\n`name` is required and at least one of `cellphone`, `email` or `document` must\nbe supplied. The payload goes through `Person\\Sanitize` (phone via\nlibphonenumber, email lower-cased, document stripped to alphanumerics).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Person created.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person"
                                            ]
                                        },
                                        "description": "Creates a record in `register.person` **without** flagging it as customer, user\nor collaborator (none of `isCustomer`/`isUser`/`isCollaborator` is set). Use\nthis when you just want a generic identity in the directory; for customer-only\nrows use `POST /api/register/customer` instead.\n\n`name` is required and at least one of `cellphone`, `email` or `document` must\nbe supplied. The payload goes through `Person\\Sanitize` (phone via\nlibphonenumber, email lower-cased, document stripped to alphanumerics).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 683752,\n    \"mainId\": null,\n    \"entityType\": \"individual\",\n    \"name\": \"Tintin\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"document\": null,\n    \"language\": \"pt_BR\",\n    \"createdAt\": \"2026-05-03T10:00:00-03:00\",\n    \"updatedAt\": \"2026-05-03T10:00:00-03:00\"\n}"
                                },
                                {
                                    "name": "Insufficient data — none of `name`, `cellphone`, `email`, `document` were provided.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person"
                                            ]
                                        },
                                        "description": "Creates a record in `register.person` **without** flagging it as customer, user\nor collaborator (none of `isCustomer`/`isUser`/`isCollaborator` is set). Use\nthis when you just want a generic identity in the directory; for customer-only\nrows use `POST /api/register/customer` instead.\n\n`name` is required and at least one of `cellphone`, `email` or `document` must\nbe supplied. The payload goes through `Person\\Sanitize` (phone via\nlibphonenumber, email lower-cased, document stripped to alphanumerics).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintim@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 412,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Get Person",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/{{idPerson}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "{{idPerson}}"
                                    ]
                                },
                                "description": "Request for registering people"
                            },
                            "response": [
                                {
                                    "name": "Successful Response",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{idPerson}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{idPerson}}"
                                            ]
                                        },
                                        "description": "Request for registering people"
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 47,\n    \"name\": \"Tintim\",\n    \"email\": \"tintim@tintim.com.br\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19966659986\",\n    \"document\": null,\n    \"language\": \"pt_BR\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Create invite",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/invite/{{idPerson}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "invite",
                                        "{{idPerson}}"
                                    ]
                                },
                                "description": "Issues an **invite token** for an existing person so they can later create\nConnect login credentials. This is the **first step** of the user-onboarding\nflow:\n\n1. The person already exists in Register (created via [Create Person](/docs/{lang}/api-reference/register/person/create) or imported from a customer feed).\n2. An admin calls this endpoint with the person's `idPerson` and receives an `inviteToken`.\n3. The token is delivered to the new user (e-mail link, magic link, QR code, etc.).\n4. The user submits the token plus their chosen `login` and `password` to [Connect · Create User](/docs/{lang}/api-reference/connect/user/create-user).\n5. Connect decrypts the token, verifies the organization + `personId`, and writes the User record.\n\nThe token is **URL-encoded** (so it can ride in a query string) and **RSA-encrypted** with Connect's public key — only Connect can decrypt it, and only for the organization the token was issued under. It's single-use: once a User is created, the token can't be redeemed again."
                            },
                            "response": [
                                {
                                    "name": "Invite token issued",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/invite/{{idPerson}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "invite",
                                                "{{idPerson}}"
                                            ]
                                        },
                                        "description": "Issues an **invite token** for an existing person so they can later create\nConnect login credentials. This is the **first step** of the user-onboarding\nflow:\n\n1. The person already exists in Register (created via [Create Person](/docs/{lang}/api-reference/register/person/create) or imported from a customer feed).\n2. An admin calls this endpoint with the person's `idPerson` and receives an `inviteToken`.\n3. The token is delivered to the new user (e-mail link, magic link, QR code, etc.).\n4. The user submits the token plus their chosen `login` and `password` to [Connect · Create User](/docs/{lang}/api-reference/connect/user/create-user).\n5. Connect decrypts the token, verifies the organization + `personId`, and writes the User record.\n\nThe token is **URL-encoded** (so it can ride in a query string) and **RSA-encrypted** with Connect's public key — only Connect can decrypt it, and only for the organization the token was issued under. It's single-use: once a User is created, the token can't be redeemed again."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"inviteToken\": \"MAjLGiKVeKFG97TaYTDwmcEgOvrICbdAgo7t%2BytNC%2FV6hJ3fSBKbLh%2F7Oju3wHli4ELaOUH0AsyWlEs%2B4hzccAZmhnG0mmLmayN2VZCQmLZbLSYVwOfW14xJ9nof5LWmHWLeazwby%2BJuYkei8Poh04Eune00pIHAvWU6Vlr3Rbk%3D\",\n    \"dateTime\":    \"2026-05-01T12:34:56-03:00\"\n}"
                                },
                                {
                                    "name": "Person not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/invite/{{idPerson}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "invite",
                                                "{{idPerson}}"
                                            ]
                                        },
                                        "description": "Issues an **invite token** for an existing person so they can later create\nConnect login credentials. This is the **first step** of the user-onboarding\nflow:\n\n1. The person already exists in Register (created via [Create Person](/docs/{lang}/api-reference/register/person/create) or imported from a customer feed).\n2. An admin calls this endpoint with the person's `idPerson` and receives an `inviteToken`.\n3. The token is delivered to the new user (e-mail link, magic link, QR code, etc.).\n4. The user submits the token plus their chosen `login` and `password` to [Connect · Create User](/docs/{lang}/api-reference/connect/user/create-user).\n5. Connect decrypts the token, verifies the organization + `personId`, and writes the User record.\n\nThe token is **URL-encoded** (so it can ride in a query string) and **RSA-encrypted** with Connect's public key — only Connect can decrypt it, and only for the organization the token was issued under. It's single-use: once a User is created, the token can't be redeemed again."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"not_found\", \"message\": \"Person not found in this organization\" }"
                                }
                            ]
                        },
                        {
                            "name": "List People",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person"
                                    ]
                                },
                                "description": "Returns the paginated list of system users (admin/staff/dev)."
                            },
                            "response": [
                                {
                                    "name": "Successful Response",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person"
                                            ]
                                        },
                                        "description": "Returns the paginated list of system users (admin/staff/dev)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 616,\n            \"entityType\": null,\n            \"name\": \"Renan\",\n            \"email\": null,\n            \"countryCallingCode\": null,\n            \"cellphone\": null,\n            \"document\": null,\n            \"gender\": null,\n            \"postalCode\": null,\n            \"dateOfBirth\": null,\n            \"language\": null,\n            \"flags\": null,\n            \"matchWith\": null,\n            \"isHomologation\": 0,\n            \"store\": null,\n            \"createdAt\": \"2023-10-17T14:32:53-03:00\",\n            \"updatedAt\": \"2024-01-09T14:40:28-03:00\"\n        },\n        {\n            \"id\": 661,\n            \"entityType\": null,\n            \"name\": \"Felipe\",\n            \"email\": \"felipe.brasil@gmail.com\",\n            \"countryCallingCode\": null,\n            \"cellphone\": null,\n            \"document\": null,\n            \"gender\": null,\n            \"postalCode\": null,\n            \"dateOfBirth\": null,\n            \"language\": null,\n            \"flags\": null,\n            \"matchWith\": null,\n            \"isHomologation\": 0,\n            \"store\": null,\n            \"createdAt\": \"2024-03-19T09:19:23-03:00\",\n            \"updatedAt\": \"2024-03-19T09:19:23-03:00\"\n        },\n        {\n            \"id\": 187670,\n            \"entityType\": null,\n            \"name\": \"Guper Teste\",\n            \"email\": \"teste@guper.co\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": null,\n            \"document\": null,\n            \"gender\": null,\n            \"postalCode\": null,\n            \"dateOfBirth\": null,\n            \"language\": null,\n            \"flags\": null,\n            \"matchWith\": null,\n            \"isHomologation\": 0,\n            \"store\": null,\n            \"createdAt\": \"2024-08-26T13:25:28-03:00\",\n            \"updatedAt\": \"2024-08-26T13:25:28-03:00\"\n        },\n        {\n            \"id\": 619,\n            \"entityType\": null,\n            \"name\": \"Carlos\",\n            \"email\": \"carlos@gmail.com\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"196654985465\",\n            \"document\": null,\n            \"gender\": null,\n            \"postalCode\": null,\n            \"dateOfBirth\": null,\n            \"language\": null,\n            \"flags\": null,\n            \"matchWith\": null,\n            \"isHomologation\": 0,\n            \"store\": null,\n            \"createdAt\": \"2023-10-17T15:43:26-03:00\",\n            \"updatedAt\": \"2023-10-17T19:09:35-03:00\"\n        },\n        {\n            \"id\": 622,\n            \"entityType\": null,\n            \"name\": \"Daniel Arbelaez\",\n            \"email\": \"daniel.arbelaez@guper.co\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"3015315043\",\n            \"document\": null,\n            \"gender\": null,\n            \"postalCode\": null,\n            \"dateOfBirth\": null,\n            \"language\": null,\n            \"flags\": null,\n            \"matchWith\": null,\n            \"isHomologation\": 0,\n            \"store\": null,\n            \"createdAt\": \"2023-10-30T21:59:25-03:00\",\n            \"updatedAt\": \"2023-10-30T21:59:25-03:00\"\n        },\n        {\n            \"id\": 623,\n            \"entityType\": null,\n            \"name\": \"Ingrid Almeida\",\n            \"email\": \"ingrid@guper.co\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"5548531717\",\n            \"document\": null,\n            \"gender\": null,\n            \"postalCode\": null,\n            \"dateOfBirth\": null,\n            \"language\": null,\n            \"flags\": null,\n            \"matchWith\": null,\n            \"isHomologation\": 0,\n            \"store\": null,\n            \"createdAt\": \"2023-10-31T23:32:48-03:00\",\n            \"updatedAt\": \"2023-10-31T23:33:28-03:00\"\n        }\n    ],\n    \"total\": 6,\n    \"pagination\": {\n        \"entries\": 100,\n        \"order\": [],\n        \"totalPages\": 1,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": true,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 0\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Remove person",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person"
                                    ]
                                },
                                "description": "Soft-deletes a person record (the model uses the standard `Tools\\Data\\Delete`\nflow which marks the row as removed). The ID goes in the request body, not in\nthe URL.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 1\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Person removed.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person"
                                            ]
                                        },
                                        "description": "Soft-deletes a person record (the model uses the standard `Tools\\Data\\Delete`\nflow which marks the row as removed). The ID goes in the request body, not in\nthe URL.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Update person",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person"
                                    ]
                                },
                                "description": "Updates a record in `register.person`. Only `id` is required; any other field\npresent in the body is updated, anything omitted is left untouched. Same\nsanitization as the create endpoint (phone via libphonenumber, email\nlower-cased, document stripped to alphanumeric).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 1,\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintin@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Person updated.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person"
                                            ]
                                        },
                                        "description": "Updates a record in `register.person`. Only `id` is required; any other field\npresent in the body is updated, anything omitted is left untouched. Same\nsanitization as the create endpoint (phone via libphonenumber, email\nlower-cased, document stripped to alphanumeric).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"name\": \"Tintin\",\n    \"entityType\": \"individual\",\n    \"document\": \"32165987\",\n    \"email\": \"tintin@guper.co\",\n    \"countryCallingCode\": 55,\n    \"cellphone\": \"19982456598\",\n    \"dateOfBirth\": \"1989-03-29\",\n    \"postalCode\": \"13450000\",\n    \"gender\": \"male\",\n    \"language\": \"pt_BR\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/register/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "register",
                                "ping"
                            ]
                        },
                        "description": "Resource for checking service availability"
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "ping"
                                    ]
                                },
                                "description": "Resource for checking service availability"
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{\n    \"account\": \"acme\",\n    \"response\": \"Server online\",\n    \"dateTime\": \"2023-08-11T13:48:50-03:00\"\n}"
                        }
                    ]
                },
                {
                    "name": "Report",
                    "item": [
                        {
                            "name": "NPS / CSAT by store — customer satisfaction & reviews",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/report/feedbackNps",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "report",
                                        "feedbackNps"
                                    ]
                                },
                                "description": "Consolidated **customer satisfaction** report — NPS, CSAT, the ratings and\nreviews customers leave — the answer to \"what's our NPS\", \"satisfaction per\nstore\", \"how are customers rating us\", \"which stores score best\", in a\n**single call**. No need to page the feedback reviews store by store. (For the\nraw responses one by one, use the feedback review list.)\n\nReturns the overall total and a per-store breakdown, with `responses`,\n`avgRating`, and how many reviews came in without a salesperson\n(`withoutSalesperson`, typically e-commerce).\n\nThe rest depends on `type`:\n\n- **`type=nps`** (0-10 scale): `promoters` (9-10), `passives` (7-8),\n  `detractors` (0-6) and the computed `nps = (promoters − detractors) /\n  responses × 100`.\n- **`type=csat`** (1-5 scale): `satisfied` (4-5), `neutral` (3),\n  `unsatisfied` (1-2) and `satisfactionRate = satisfied / responses` (a ratio,\n  `0.967` = 96.7%). The NPS fields are **not** emitted for CSAT — a 1-5 rating is\n  never a \"detractor\" on the 0-10 band, so an NPS score there is meaningless."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/feedbackNps",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "feedbackNps"
                                            ]
                                        },
                                        "description": "Consolidated **customer satisfaction** report — NPS, CSAT, the ratings and\nreviews customers leave — the answer to \"what's our NPS\", \"satisfaction per\nstore\", \"how are customers rating us\", \"which stores score best\", in a\n**single call**. No need to page the feedback reviews store by store. (For the\nraw responses one by one, use the feedback review list.)\n\nReturns the overall total and a per-store breakdown, with `responses`,\n`avgRating`, and how many reviews came in without a salesperson\n(`withoutSalesperson`, typically e-commerce).\n\nThe rest depends on `type`:\n\n- **`type=nps`** (0-10 scale): `promoters` (9-10), `passives` (7-8),\n  `detractors` (0-6) and the computed `nps = (promoters − detractors) /\n  responses × 100`.\n- **`type=csat`** (1-5 scale): `satisfied` (4-5), `neutral` (3),\n  `unsatisfied` (1-2) and `satisfactionRate = satisfied / responses` (a ratio,\n  `0.967` = 96.7%). The NPS fields are **not** emitted for CSAT — a 1-5 rating is\n  never a \"detractor\" on the 0-10 band, so an NPS score there is meaningless."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": { \"type\": \"nps\", \"period\": { \"start\": \"2026-06-11\", \"end\": \"2026-09-09\" }, \"store\": null },\n  \"total\": {\n    \"stores\": 58, \"responses\": 3753,\n    \"promoters\": 3637, \"passives\": 75, \"detractors\": 41,\n    \"nps\": 95.8, \"avgRating\": 9.82,\n    \"withoutSalesperson\": 1136, \"withoutSalespersonPct\": 0.3027\n  },\n  \"byStore\": [\n    { \"storeId\": 40,  \"store\": \"ECOMMERCE\",            \"responses\": 478, \"promoters\": 459, \"passives\": 7, \"detractors\": 12, \"nps\": 93.5, \"avgRating\": 9.73, \"withoutSalesperson\": 478, \"withoutSalespersonPct\": 1 },\n    { \"storeId\": 155, \"store\": \"CC MERIDA ALTABRISA\",  \"responses\": 195, \"promoters\": 191, \"passives\": 4, \"detractors\": 0,  \"nps\": 97.9, \"avgRating\": 9.90, \"withoutSalesperson\": 34,  \"withoutSalespersonPct\": 0.1744 },\n    { \"storeId\": 138, \"store\": \"CC MERIDA GALERIAS\",   \"responses\": 162, \"promoters\": 161, \"passives\": 1, \"detractors\": 0,  \"nps\": 99.4, \"avgRating\": 9.90, \"withoutSalesperson\": 25,  \"withoutSalespersonPct\": 0.1543 }\n  ]\n}"
                                },
                                {
                                    "name": "OK — `type=csat`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/feedbackNps",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "feedbackNps"
                                            ]
                                        },
                                        "description": "Consolidated **customer satisfaction** report — NPS, CSAT, the ratings and\nreviews customers leave — the answer to \"what's our NPS\", \"satisfaction per\nstore\", \"how are customers rating us\", \"which stores score best\", in a\n**single call**. No need to page the feedback reviews store by store. (For the\nraw responses one by one, use the feedback review list.)\n\nReturns the overall total and a per-store breakdown, with `responses`,\n`avgRating`, and how many reviews came in without a salesperson\n(`withoutSalesperson`, typically e-commerce).\n\nThe rest depends on `type`:\n\n- **`type=nps`** (0-10 scale): `promoters` (9-10), `passives` (7-8),\n  `detractors` (0-6) and the computed `nps = (promoters − detractors) /\n  responses × 100`.\n- **`type=csat`** (1-5 scale): `satisfied` (4-5), `neutral` (3),\n  `unsatisfied` (1-2) and `satisfactionRate = satisfied / responses` (a ratio,\n  `0.967` = 96.7%). The NPS fields are **not** emitted for CSAT — a 1-5 rating is\n  never a \"detractor\" on the 0-10 band, so an NPS score there is meaningless."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": { \"type\": \"csat\", \"period\": { \"start\": \"2026-07-01\", \"end\": \"2026-09-30\" }, \"store\": null },\n  \"total\": {\n    \"stores\": 55, \"responses\": 3006,\n    \"satisfied\": 2908, \"neutral\": 65, \"unsatisfied\": 33,\n    \"satisfactionRate\": 0.9674, \"avgRating\": 4.85,\n    \"withoutSalesperson\": 378, \"withoutSalespersonPct\": 0.1257\n  },\n  \"byStore\": [ { \"storeId\": 40, \"store\": \"ECOMMERCE\", \"responses\": 230, \"satisfied\": 222, \"neutral\": 5, \"unsatisfied\": 3, \"satisfactionRate\": 0.9652, \"avgRating\": 4.83, \"withoutSalesperson\": 230, \"withoutSalespersonPct\": 1 } ]\n}"
                                },
                                {
                                    "name": "OK — `groupBy=month`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/feedbackNps",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "feedbackNps"
                                            ]
                                        },
                                        "description": "Consolidated **customer satisfaction** report — NPS, CSAT, the ratings and\nreviews customers leave — the answer to \"what's our NPS\", \"satisfaction per\nstore\", \"how are customers rating us\", \"which stores score best\", in a\n**single call**. No need to page the feedback reviews store by store. (For the\nraw responses one by one, use the feedback review list.)\n\nReturns the overall total and a per-store breakdown, with `responses`,\n`avgRating`, and how many reviews came in without a salesperson\n(`withoutSalesperson`, typically e-commerce).\n\nThe rest depends on `type`:\n\n- **`type=nps`** (0-10 scale): `promoters` (9-10), `passives` (7-8),\n  `detractors` (0-6) and the computed `nps = (promoters − detractors) /\n  responses × 100`.\n- **`type=csat`** (1-5 scale): `satisfied` (4-5), `neutral` (3),\n  `unsatisfied` (1-2) and `satisfactionRate = satisfied / responses` (a ratio,\n  `0.967` = 96.7%). The NPS fields are **not** emitted for CSAT — a 1-5 rating is\n  never a \"detractor\" on the 0-10 band, so an NPS score there is meaningless."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": { \"type\": \"nps\", \"period\": { \"start\": \"2026-07-01\", \"end\": \"2026-09-30\" }, \"timezone\": \"America/Mexico_City\", \"groupBy\": [\"month\"], \"filters\": { \"clients\": null, \"orders\": null } },\n  \"total\": { \"stores\": 60, \"responses\": 3738, \"promoters\": 3625, \"passives\": 72, \"detractors\": 41, \"nps\": 95.9, \"avgRating\": 9.82, \"withoutSalesperson\": 836, \"withoutSalespersonPct\": 0.2237 },\n  \"rows\": [\n    { \"month\": \"2026-08\", \"responses\": 1668, \"promoters\": 1620, \"passives\": 35, \"detractors\": 13, \"nps\": 96.4, \"avgRating\": 9.83, \"withoutSalesperson\": 316, \"withoutSalespersonPct\": 0.1894 },\n    { \"month\": \"2026-07\", \"responses\": 1223, \"promoters\": 1182, \"passives\": 23, \"detractors\": 18, \"nps\": 95.2, \"avgRating\": 9.80, \"withoutSalesperson\": 300, \"withoutSalespersonPct\": 0.2453 },\n    { \"month\": \"2026-09\", \"responses\": 847,  \"promoters\": 823,  \"passives\": 14, \"detractors\": 10, \"nps\": 96.3, \"avgRating\": 9.84, \"withoutSalesperson\": 220, \"withoutSalespersonPct\": 0.2597 }\n  ]\n}"
                                },
                                {
                                    "name": "Invalid `type` or `groupBy`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/feedbackNps",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "feedbackNps"
                                            ]
                                        },
                                        "description": "Consolidated **customer satisfaction** report — NPS, CSAT, the ratings and\nreviews customers leave — the answer to \"what's our NPS\", \"satisfaction per\nstore\", \"how are customers rating us\", \"which stores score best\", in a\n**single call**. No need to page the feedback reviews store by store. (For the\nraw responses one by one, use the feedback review list.)\n\nReturns the overall total and a per-store breakdown, with `responses`,\n`avgRating`, and how many reviews came in without a salesperson\n(`withoutSalesperson`, typically e-commerce).\n\nThe rest depends on `type`:\n\n- **`type=nps`** (0-10 scale): `promoters` (9-10), `passives` (7-8),\n  `detractors` (0-6) and the computed `nps = (promoters − detractors) /\n  responses × 100`.\n- **`type=csat`** (1-5 scale): `satisfied` (4-5), `neutral` (3),\n  `unsatisfied` (1-2) and `satisfactionRate = satisfied / responses` (a ratio,\n  `0.967` = 96.7%). The NPS fields are **not** emitted for CSAT — a 1-5 rating is\n  never a \"detractor\" on the 0-10 band, so an NPS score there is meaningless."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Program members / associates report",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/report/members",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "report",
                                        "members"
                                    ]
                                },
                                "description": "Who the **members / associates** of a loyalty program are, org-wide, in a\n**single call** — how many there are, their tier and source mix, how many have\never bought, and what they are worth over their lifetime. The answer to \"how\nmany associates do we have\", \"how many members converted into buyers\", \"what is\nthe member base\".\n\nGeneric: parameterized by `tierConfig` (any org's program). It is **register-only**\n— built from `person_membership` + `person_tier` + `person_rfm`, no call to the\norder service. `total` carries `members` (active), `buyersLifetime`,\n`conversionLifetime` and `lifetimeValue`; `byTier`, `bySource` and `byMonth`\n(member growth) break it down.\n\nRead the lens carefully:\n- **`conversionLifetime`** = members who have **ever** bought (`person_rfm`) — it is\n  **lifetime**, NOT conversion in a period.\n- **`lifetimeValue`** = the members' total lifetime spend (gross, all stores). Values\n  in **cents**. It is **not** revenue in a period.\n- **`meta.membershipStartedAt`** = the first month with a join. Before that there are\n  no members, so comparing \"revenue from members\" against a long period must stay\n  inside the window that has membership.\n\nNot here on purpose: **revenue from members in a period** — that belongs to the order\nservice (`total_order` cut by date), via `order.report.sales` and the\n`order_personMembership` snapshot (which exists only from ~2026-05-28). This report\nis the lifetime/structural view of the member base."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/members",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "members"
                                            ]
                                        },
                                        "description": "Who the **members / associates** of a loyalty program are, org-wide, in a\n**single call** — how many there are, their tier and source mix, how many have\never bought, and what they are worth over their lifetime. The answer to \"how\nmany associates do we have\", \"how many members converted into buyers\", \"what is\nthe member base\".\n\nGeneric: parameterized by `tierConfig` (any org's program). It is **register-only**\n— built from `person_membership` + `person_tier` + `person_rfm`, no call to the\norder service. `total` carries `members` (active), `buyersLifetime`,\n`conversionLifetime` and `lifetimeValue`; `byTier`, `bySource` and `byMonth`\n(member growth) break it down.\n\nRead the lens carefully:\n- **`conversionLifetime`** = members who have **ever** bought (`person_rfm`) — it is\n  **lifetime**, NOT conversion in a period.\n- **`lifetimeValue`** = the members' total lifetime spend (gross, all stores). Values\n  in **cents**. It is **not** revenue in a period.\n- **`meta.membershipStartedAt`** = the first month with a join. Before that there are\n  no members, so comparing \"revenue from members\" against a long period must stay\n  inside the window that has membership.\n\nNot here on purpose: **revenue from members in a period** — that belongs to the order\nservice (`total_order` cut by date), via `order.report.sales` and the\n`order_personMembership` snapshot (which exists only from ~2026-05-28). This report\nis the lifetime/structural view of the member base."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"tierConfig\": 1, \"program\": \"The program's name\",\n    \"membershipStartedAt\": \"2026-03\", \"unit\": \"cents\"\n  },\n  \"total\": {\n    \"members\": 717, \"buyersLifetime\": 453, \"conversionLifetime\": 0.6318,\n    \"lifetimeValue\": 130439911, \"avgLifetimeValue\": 181925\n  },\n  \"byTier\": [\n    { \"levelId\": 1, \"levelName\": \"Entry\", \"members\": 618 },\n    { \"levelId\": 2, \"levelName\": \"Mid\",   \"members\": 78 }\n  ],\n  \"bySource\": [\n    { \"source\": \"optin_hook\", \"members\": 419 },\n    { \"source\": \"backfill\",   \"members\": 298 }\n  ],\n  \"byMonth\": [\n    { \"month\": \"2026-03\", \"joined\": 95, \"left\": 0, \"activeEnd\": 95 },\n    { \"month\": \"2026-04\", \"joined\": 107, \"left\": 0, \"activeEnd\": 202 }\n  ]\n}"
                                },
                                {
                                    "name": "Org has no program, or has more than one and `tierConfig` was not given, or the given `tierConfig` is invalid.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/members",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "members"
                                            ]
                                        },
                                        "description": "Who the **members / associates** of a loyalty program are, org-wide, in a\n**single call** — how many there are, their tier and source mix, how many have\never bought, and what they are worth over their lifetime. The answer to \"how\nmany associates do we have\", \"how many members converted into buyers\", \"what is\nthe member base\".\n\nGeneric: parameterized by `tierConfig` (any org's program). It is **register-only**\n— built from `person_membership` + `person_tier` + `person_rfm`, no call to the\norder service. `total` carries `members` (active), `buyersLifetime`,\n`conversionLifetime` and `lifetimeValue`; `byTier`, `bySource` and `byMonth`\n(member growth) break it down.\n\nRead the lens carefully:\n- **`conversionLifetime`** = members who have **ever** bought (`person_rfm`) — it is\n  **lifetime**, NOT conversion in a period.\n- **`lifetimeValue`** = the members' total lifetime spend (gross, all stores). Values\n  in **cents**. It is **not** revenue in a period.\n- **`meta.membershipStartedAt`** = the first month with a join. Before that there are\n  no members, so comparing \"revenue from members\" against a long period must stay\n  inside the window that has membership.\n\nNot here on purpose: **revenue from members in a period** — that belongs to the order\nservice (`total_order` cut by date), via `order.report.sales` and the\n`order_personMembership` snapshot (which exists only from ~2026-05-28). This report\nis the lifetime/structural view of the member base."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Customer RFM by acquisition cohort — new customers / sign-ups per day",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/report/rfm-cohort/{{dateStart}}/{{dateEnd}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "report",
                                        "rfm-cohort",
                                        "{{dateStart}}",
                                        "{{dateEnd}}"
                                    ]
                                },
                                "description": "Customer RFM aggregated by **acquisition cohort** — how many customers were\nacquired in each month (or at each store), and what they are worth over their\nlifetime — in a **single call**. It is the RFM base, grouped: instead of\npaging ~hundreds of thousands of per-customer rows and grouping client-side,\nthis returns the cohort rollup at once.\n\nA cohort is cut by the **first-purchase date** (`firstPurchaseDate`). Group by\n`month` (acquisition month), `firstStore` (acquisition store), or both. Per\ncohort you get `clients`, `lifetimeValue` and `avgValue` (spend), `avgOrders`\n(frequency), `avgCadenceDays` (repeat interval, only over customers with 2+\norders) and `avgDaysWithoutPurchase` (recency today).\n\nValues are in **cents**. The month is cut in the organization timezone, so\ncohorts line up with the sales report by (month, store). `total` reconciles\nwith the sum of the rows by construction.\n\nRead the semantics carefully: **store is the acquisition store** and\n**`lifetimeValue` is the customer's org-wide lifetime spend** (across every\nstore), not the store's sales — \"customers acquired at store X and what they\nspent everywhere\". For store sales use `order.report.sales`; do not mix them."
                            },
                            "response": [
                                {
                                    "name": "OK — with `groupBy=month`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/rfm-cohort/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "rfm-cohort",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Customer RFM aggregated by **acquisition cohort** — how many customers were\nacquired in each month (or at each store), and what they are worth over their\nlifetime — in a **single call**. It is the RFM base, grouped: instead of\npaging ~hundreds of thousands of per-customer rows and grouping client-side,\nthis returns the cohort rollup at once.\n\nA cohort is cut by the **first-purchase date** (`firstPurchaseDate`). Group by\n`month` (acquisition month), `firstStore` (acquisition store), or both. Per\ncohort you get `clients`, `lifetimeValue` and `avgValue` (spend), `avgOrders`\n(frequency), `avgCadenceDays` (repeat interval, only over customers with 2+\norders) and `avgDaysWithoutPurchase` (recency today).\n\nValues are in **cents**. The month is cut in the organization timezone, so\ncohorts line up with the sales report by (month, store). `total` reconciles\nwith the sum of the rows by construction.\n\nRead the semantics carefully: **store is the acquisition store** and\n**`lifetimeValue` is the customer's org-wide lifetime spend** (across every\nstore), not the store's sales — \"customers acquired at store X and what they\nspent everywhere\". For store sales use `order.report.sales`; do not mix them."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"meta\": {\n    \"unit\": \"cents\", \"timezone\": \"Etc/GMT+6\",\n    \"groupBy\": [\"month\"],\n    \"window\": { \"dateStart\": \"2025-01-01\", \"dateEnd\": \"2025-06-30\" }\n  },\n  \"rows\": [\n    { \"month\": \"2025-01\", \"clients\": 16131, \"lifetimeValue\": 4676422124, \"avgValue\": 289903,\n      \"avgOrders\": 1.50, \"avgCadenceDays\": 98.1, \"avgDaysWithoutPurchase\": 435 },\n    { \"month\": \"2025-02\", \"clients\": 8890, \"lifetimeValue\": 2766238779, \"avgValue\": 311163,\n      \"avgOrders\": 1.49, \"avgCadenceDays\": 94.2, \"avgDaysWithoutPurchase\": 410 }\n  ],\n  \"total\": {\n    \"clients\": 74775, \"lifetimeValue\": 24488794816, \"avgValue\": 327500,\n    \"avgOrders\": 2.49, \"avgCadenceDays\": 78, \"avgDaysWithoutPurchase\": 366\n  }\n}"
                                },
                                {
                                    "name": "Invalid `groupBy`, or `dateStart` after `dateEnd`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/report/rfm-cohort/{{dateStart}}/{{dateEnd}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "report",
                                                "rfm-cohort",
                                                "{{dateStart}}",
                                                "{{dateEnd}}"
                                            ]
                                        },
                                        "description": "Customer RFM aggregated by **acquisition cohort** — how many customers were\nacquired in each month (or at each store), and what they are worth over their\nlifetime — in a **single call**. It is the RFM base, grouped: instead of\npaging ~hundreds of thousands of per-customer rows and grouping client-side,\nthis returns the cohort rollup at once.\n\nA cohort is cut by the **first-purchase date** (`firstPurchaseDate`). Group by\n`month` (acquisition month), `firstStore` (acquisition store), or both. Per\ncohort you get `clients`, `lifetimeValue` and `avgValue` (spend), `avgOrders`\n(frequency), `avgCadenceDays` (repeat interval, only over customers with 2+\norders) and `avgDaysWithoutPurchase` (recency today).\n\nValues are in **cents**. The month is cut in the organization timezone, so\ncohorts line up with the sales report by (month, store). `total` reconciles\nwith the sum of the rows by construction.\n\nRead the semantics carefully: **store is the acquisition store** and\n**`lifetimeValue` is the customer's org-wide lifetime spend** (across every\nstore), not the store's sales — \"customers acquired at store X and what they\nspent everywhere\". For store sales use `order.report.sales`; do not mix them."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Segmentation",
                    "item": [
                        {
                            "name": "Tags",
                            "item": [
                                {
                                    "name": "Create segmentation tag",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tags",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tags"
                                            ]
                                        },
                                        "description": "Creates a tag in the organization's segmentation taxonomy. Tags belong to a\n`category` (which itself has a `type` — `tier`, `behavior`, `customerTag`, …\n— that decides which manager handles the tag). The endpoint dispatches to the\nmatching `Segmentation\\Manager` based on the resolved category type, defaulting\nto the *Standard* manager when no special handler is registered.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"VIP\",\n    \"category\": 7,\n    \"priority\": 100,\n    \"data\": {\n        \"color\": \"#FFD700\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Tag created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tags",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tags"
                                                    ]
                                                },
                                                "description": "Creates a tag in the organization's segmentation taxonomy. Tags belong to a\n`category` (which itself has a `type` — `tier`, `behavior`, `customerTag`, …\n— that decides which manager handles the tag). The endpoint dispatches to the\nmatching `Segmentation\\Manager` based on the resolved category type, defaulting\nto the *Standard* manager when no special handler is registered.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"VIP\",\n    \"category\": 7,\n    \"priority\": 100,\n    \"data\": {\n        \"color\": \"#FFD700\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 42,\n    \"name\": \"VIP\",\n    \"type\": null,\n    \"category\": 7,\n    \"priority\": 100,\n    \"data\": { \"color\": \"#FFD700\" }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Tags",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tags",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tags"
                                            ]
                                        },
                                        "description": "Returns a paginated list of resources."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tags",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tags"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of resources."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Stores",
                    "item": [
                        {
                            "name": "Store",
                            "item": [
                                {
                                    "name": "Create Store",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store"
                                            ]
                                        },
                                        "description": "Cria uma loja na organização. `name` é o único campo obrigatório.\n\n`interface` + `refId` formam o par usado pelo middleware para resolver\na loja a partir de IDs externos (VTEX, ERP etc.).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Loja 3\",\n    \"refId\": \"L-003\",\n    \"interface\": \"vtex\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store"
                                                    ]
                                                },
                                                "description": "Cria uma loja na organização. `name` é o único campo obrigatório.\n\n`interface` + `refId` formam o par usado pelo middleware para resolver\na loja a partir de IDs externos (VTEX, ERP etc.).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Loja 3\",\n    \"refId\": \"L-003\",\n    \"interface\": \"vtex\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 22,\n    \"name\": \"Loja 3\",\n    \"refId\": \"L-003\",\n    \"interface\": \"vtex\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Stores",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store"
                                            ]
                                        },
                                        "description": "Returns a paginated list of resources."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of resources."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Load",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a store's details by internal ID."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a store's details by internal ID."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 194,\n    \"refId\": \"2\",\n    \"name\": \"UNNAMED - 2\",\n    \"interface\": \"\",\n    \"policie\": [\n        14,\n        15\n    ],\n    \"policy\": [\n        14,\n        15\n    ],\n    \"channels\": [\n        23\n    ]\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove Store",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store"
                                            ]
                                        },
                                        "description": "Remove uma loja. Falha se ainda existirem links de carteira ou de\ngrupo de lojas apontando para ela — apague esses vínculos antes\n(`/store/walletLink` e `/linkStoreGroup`).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store"
                                                    ]
                                                },
                                                "description": "Remove uma loja. Falha se ainda existirem links de carteira ou de\ngrupo de lojas apontando para ela — apague esses vínculos antes\n(`/store/walletLink` e `/linkStoreGroup`).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Store",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store"
                                            ]
                                        },
                                        "description": "Atualiza uma loja. Envie apenas os campos que mudam — `id` é obrigatório.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 22,\n    \"name\": \"Loja 1\",\n    \"refId\": \"L-001\",\n    \"interface\": \"vtex\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store"
                                                    ]
                                                },
                                                "description": "Atualiza uma loja. Envie apenas os campos que mudam — `id` é obrigatório.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 22,\n    \"name\": \"Loja 1\",\n    \"refId\": \"L-001\",\n    \"interface\": \"vtex\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Store By",
                            "item": [
                                {
                                    "name": "Interface And RefId",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store/by/interface/{{interface}}/refId/{{refId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store",
                                                "by",
                                                "interface",
                                                "{{interface}}",
                                                "refId",
                                                "{{refId}}"
                                            ]
                                        },
                                        "description": "Returns a store's details using its external `interface` + `refId` instead of the internal ID."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/by/interface/{{interface}}/refId/{{refId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "by",
                                                        "interface",
                                                        "{{interface}}",
                                                        "refId",
                                                        "{{refId}}"
                                                    ]
                                                },
                                                "description": "Returns a store's details using its external `interface` + `refId` instead of the internal ID."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Store Group",
                            "item": [
                                {
                                    "name": "Create Store Group",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "storeGroup"
                                            ]
                                        },
                                        "description": "Cria um grupo de lojas (`storeGroup`). Grupos são usados para\norganizar lojas por região, canal ou bandeira, e para vincular regras\nde loyalty/cashback a múltiplas lojas de uma vez.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Região Sul\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "storeGroup"
                                                    ]
                                                },
                                                "description": "Cria um grupo de lojas (`storeGroup`). Grupos são usados para\norganizar lojas por região, canal ou bandeira, e para vincular regras\nde loyalty/cashback a múltiplas lojas de uma vez.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Região Sul\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"name\": \"Região Sul\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Store Groups",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "storeGroup"
                                            ]
                                        },
                                        "description": "Request for registering people"
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "storeGroup"
                                                    ]
                                                },
                                                "description": "Request for registering people"
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Load",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/storeGroup/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "storeGroup",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Carrega um grupo de lojas pelo seu `id`. Retorna apenas os campos\nbásicos do grupo (id e nome) — para listar os links com lojas, use\n`GET /api/register/linkStoreGroup`."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/storeGroup/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "storeGroup",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Carrega um grupo de lojas pelo seu `id`. Retorna apenas os campos\nbásicos do grupo (id e nome) — para listar os links com lojas, use\n`GET /api/register/linkStoreGroup`."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 1,\n    \"name\": \"Região Sul\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Remove Store Group",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "storeGroup"
                                            ]
                                        },
                                        "description": "Remove um grupo de lojas. Falha se ainda existirem lojas vinculadas\n— desvincule pelo `/linkStoreGroup` antes.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "storeGroup"
                                                    ]
                                                },
                                                "description": "Remove um grupo de lojas. Falha se ainda existirem lojas vinculadas\n— desvincule pelo `/linkStoreGroup` antes.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Store Group",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "storeGroup"
                                            ]
                                        },
                                        "description": "Atualiza um grupo de lojas. `id` é obrigatório.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 1,\n    \"name\": \"Região Leste\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/storeGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "storeGroup"
                                                    ]
                                                },
                                                "description": "Atualiza um grupo de lojas. `id` é obrigatório.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 1,\n    \"name\": \"Região Leste\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Store Wallet Link",
                            "item": [
                                {
                                    "name": "Create store ↔ policy link",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store",
                                                "walletLink"
                                            ]
                                        },
                                        "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nCreates **one** link. To set every store of a policy at once, use [Sync store ↔ policy links](/docs/{lang}/api-reference/register/stores/store-wallet-link/sync).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"store\": 22,\n    \"wallet\": 108\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nCreates **one** link. To set every store of a policy at once, use [Sync store ↔ policy links](/docs/{lang}/api-reference/register/stores/store-wallet-link/sync).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"store\": 22,\n    \"wallet\": 108\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"store\": 22,\n    \"wallet\": 108,\n    \"organization\": \"acme\",\n    \"dateTime\": \"2026-10-03T10:15:00-03:00\"\n}"
                                        },
                                        {
                                            "name": "Link already exists or store does not exist",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nCreates **one** link. To set every store of a policy at once, use [Sync store ↔ policy links](/docs/{lang}/api-reference/register/stores/store-wallet-link/sync).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"store\": 22,\n    \"wallet\": 108\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 418,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"message\": \"Unable to process this record\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete store ↔ policy link",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store",
                                                "walletLink"
                                            ]
                                        },
                                        "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nRemoves **one** link, identified by the `(store, wallet)` pair. From then on the policy no longer applies at that store.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"store\": 22,\n    \"wallet\": 108\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nRemoves **one** link, identified by the `(store, wallet)` pair. From then on the policy no longer applies at that store.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"store\": 22,\n    \"wallet\": 108\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"store\": 22, \"wallet\": 108, \"dateTime\": \"2026-10-03T10:15:00-03:00\" }"
                                        },
                                        {
                                            "name": "Link not found",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nRemoves **one** link, identified by the `(store, wallet)` pair. From then on the policy no longer applies at that store.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"store\": 22,\n    \"wallet\": 108\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 418,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"message\": \"It is not possible to delete this register\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "List store ↔ policy links",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store",
                                                "walletLink"
                                            ]
                                        },
                                        "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nLists the links. Filter by one side with `q[wallet]=108` (stores of a policy) or `q[store]=22` (policies of a store). Send `with=store` to get each store as an object (`id`, `name`, `refId`, `interface`) instead of the id.\n\nHow the policies are applied to an order (cap, aggregation mode and the competition\nbetween policies), with examples: [Redemption policies](/docs/{lang}/guides/redemption-policies)."
                                    },
                                    "response": [
                                        {
                                            "name": "OK (with=store)",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nLists the links. Filter by one side with `q[wallet]=108` (stores of a policy) or `q[store]=22` (policies of a store). Send `with=store` to get each store as an object (`id`, `name`, `refId`, `interface`) instead of the id.\n\nHow the policies are applied to an order (cap, aggregation mode and the competition\nbetween policies), with examples: [Redemption policies](/docs/{lang}/guides/redemption-policies)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        {\n            \"store\": { \"id\": 22, \"name\": \"Boutique Centro\", \"refId\": \"BTQ01\", \"interface\": \"zoku\" },\n            \"wallet\": 108\n        }\n    ],\n    \"total\": 1,\n    \"pagination\": {\n        \"entries\": 0,\n        \"order\": [],\n        \"totalPages\": 1,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": true,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 0\n    }\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Sync store ↔ policy links",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "store",
                                                "walletLink"
                                            ]
                                        },
                                        "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nSets **all** the links of one side at once, in a single transaction. Anchor one side and send the\n**complete** list of the other:\n\n- `{\"wallet\": 108, \"stores\": [22, 23, 41]}` — the policy will apply exactly at these stores.\n- `{\"store\": 22, \"wallets\": [108, 109]}` — exactly these policies will apply at this store.\n\nThe list is the **final state**, not an increment: links missing from it are removed, and an\n**empty list removes every link** of the anchor. Invalid ids (`0`, negative, non-numeric) are\nignored, and repeated ids are merged. Sending the same body twice gives the same result.\n\nIf any store does not exist in the organization, nothing is changed and the response is `422`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"wallet\": 108,\n    \"stores\": [\n        22,\n        23,\n        41\n    ],\n    \"store\": null,\n    \"wallets\": null\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nSets **all** the links of one side at once, in a single transaction. Anchor one side and send the\n**complete** list of the other:\n\n- `{\"wallet\": 108, \"stores\": [22, 23, 41]}` — the policy will apply exactly at these stores.\n- `{\"store\": 22, \"wallets\": [108, 109]}` — exactly these policies will apply at this store.\n\nThe list is the **final state**, not an increment: links missing from it are removed, and an\n**empty list removes every link** of the anchor. Invalid ids (`0`, negative, non-numeric) are\nignored, and repeated ids are merged. Sending the same body twice gives the same result.\n\nIf any store does not exist in the organization, nothing is changed and the response is `422`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"wallet\": 108,\n    \"stores\": [\n        22,\n        23,\n        41\n    ],\n    \"store\": null,\n    \"wallets\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"organization\": \"acme\",\n    \"wallet\": 108,\n    \"linked\": [22, 23, 41],\n    \"created\": 1,\n    \"removed\": 2\n}"
                                        },
                                        {
                                            "name": "Neither form of the body was sent",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nSets **all** the links of one side at once, in a single transaction. Anchor one side and send the\n**complete** list of the other:\n\n- `{\"wallet\": 108, \"stores\": [22, 23, 41]}` — the policy will apply exactly at these stores.\n- `{\"store\": 22, \"wallets\": [108, 109]}` — exactly these policies will apply at this store.\n\nThe list is the **final state**, not an increment: links missing from it are removed, and an\n**empty list removes every link** of the anchor. Invalid ids (`0`, negative, non-numeric) are\nignored, and repeated ids are merged. Sending the same body twice gives the same result.\n\nIf any store does not exist in the organization, nothing is changed and the response is `422`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"wallet\": 108,\n    \"stores\": [\n        22,\n        23,\n        41\n    ],\n    \"store\": null,\n    \"wallets\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"message\": \"Json parameters are missing: ( wallet, stores ) or ( store, wallets )\" }"
                                        },
                                        {
                                            "name": "A store does not exist in the organization",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/store/walletLink",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "store",
                                                        "walletLink"
                                                    ]
                                                },
                                                "description": "A redemption policy only applies at the stores linked to it. Each link is a `(store, wallet)` pair, where `wallet` is the policy id.\n\nSets **all** the links of one side at once, in a single transaction. Anchor one side and send the\n**complete** list of the other:\n\n- `{\"wallet\": 108, \"stores\": [22, 23, 41]}` — the policy will apply exactly at these stores.\n- `{\"store\": 22, \"wallets\": [108, 109]}` — exactly these policies will apply at this store.\n\nThe list is the **final state**, not an increment: links missing from it are removed, and an\n**empty list removes every link** of the anchor. Invalid ids (`0`, negative, non-numeric) are\nignored, and repeated ids are merged. Sending the same body twice gives the same result.\n\nIf any store does not exist in the organization, nothing is changed and the response is `422`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"wallet\": 108,\n    \"stores\": [\n        22,\n        23,\n        41\n    ],\n    \"store\": null,\n    \"wallets\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"message\": \"store(s) inexistente(s) nesta organizacao: 999\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Stores StoreGroups Link",
                            "item": [
                                {
                                    "name": "Link Store to Group",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/linkStoreGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "linkStoreGroup"
                                            ]
                                        },
                                        "description": "Liga uma loja a um grupo de lojas (`storeGroup`). A presença do par\n`(store, storeGroup)` na tabela `store_storeGroup` é o que faz a\nloja participar do grupo (canal/região/bandeira).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"store\": 1,\n    \"storeGroup\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/linkStoreGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "linkStoreGroup"
                                                    ]
                                                },
                                                "description": "Liga uma loja a um grupo de lojas (`storeGroup`). A presença do par\n`(store, storeGroup)` na tabela `store_storeGroup` é o que faz a\nloja participar do grupo (canal/região/bandeira).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"store\": 1,\n    \"storeGroup\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"store\": 1,\n    \"storeGroup\": 1,\n    \"organization\": \"acme\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Unlink Store from Group",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/linkStoreGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "linkStoreGroup"
                                            ]
                                        },
                                        "description": "Remove o vínculo loja↔grupo. Os dois identificadores são obrigatórios\n— a remoção é feita pela chave composta `(store, storeGroup)`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"store\": 1,\n    \"storeGroup\": 1\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/linkStoreGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "linkStoreGroup"
                                                    ]
                                                },
                                                "description": "Remove o vínculo loja↔grupo. Os dois identificadores são obrigatórios\n— a remoção é feita pela chave composta `(store, storeGroup)`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"store\": 1,\n    \"storeGroup\": 1\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Store-Group Links",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/linkStoreGroup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "linkStoreGroup"
                                            ]
                                        },
                                        "description": "Returns a paginated list of resources."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/linkStoreGroup",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "linkStoreGroup"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of resources."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Team",
                    "item": [
                        {
                            "name": "Áreas",
                            "item": [
                                {
                                    "name": "Create Area",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area"
                                            ]
                                        },
                                        "description": "Cria uma área no organograma. `name` é o único campo obrigatório.\n\nSe `parentId` for informado, o `CycleGuard` valida que a referência não\ncria ciclo na árvore de áreas e que o pai pertence à mesma organização.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Marketing\",\n    \"parentId\": 1,\n    \"description\": \"Marketing & Growth\",\n    \"data\": {\n        \"color\": \"#ff7a00\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Cria uma área no organograma. `name` é o único campo obrigatório.\n\nSe `parentId` for informado, o `CycleGuard` valida que a referência não\ncria ciclo na árvore de áreas e que o pai pertence à mesma organização.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Marketing\",\n    \"parentId\": 1,\n    \"description\": \"Marketing & Growth\",\n    \"data\": {\n        \"color\": \"#ff7a00\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2,\n    \"parentId\": 1,\n    \"name\": \"Marketing\",\n    \"description\": \"Marketing & Growth\",\n    \"data\": { \"color\": \"#ff7a00\" }\n}"
                                        },
                                        {
                                            "name": "Cycle / parent inválido",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Cria uma área no organograma. `name` é o único campo obrigatório.\n\nSe `parentId` for informado, o `CycleGuard` valida que a referência não\ncria ciclo na árvore de áreas e que o pai pertence à mesma organização.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Marketing\",\n    \"parentId\": 1,\n    \"description\": \"Marketing & Growth\",\n    \"data\": {\n        \"color\": \"#ff7a00\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"parentId would create a cycle in the area tree\",\n    \"code\": 422\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete Area",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area"
                                            ]
                                        },
                                        "description": "Remove uma área. Falha (FK RESTRICT) se houver sub-áreas ou cargos vinculados —\napague-os antes ou mova-os para outra área.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 2\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Remove uma área. Falha (FK RESTRICT) se houver sub-áreas ou cargos vinculados —\napague-os antes ou mova-os para outra área.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 2\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        },
                                        {
                                            "name": "Constraint — sub-áreas ou cargos vinculados",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Remove uma área. Falha (FK RESTRICT) se houver sub-áreas ou cargos vinculados —\napague-os antes ou mova-os para outra área.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 2\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"Cannot delete or update a parent row: a foreign key constraint fails\",\n    \"code\": 409\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Area",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single the area matching the given identifier."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single the area matching the given identifier."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2,\n    \"parentId\": 1,\n    \"name\": \"Marketing\",\n    \"description\": \"Marketing & Growth\",\n    \"data\": { \"color\": \"#ff7a00\" },\n    \"createdAt\": \"2026-04-24 10:01:00\",\n    \"updatedAt\": \"2026-04-24 10:01:00\"\n}"
                                        },
                                        {
                                            "name": "Not Found",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single the area matching the given identifier."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"Not Found\",\n    \"code\": 404\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Areas",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area"
                                            ]
                                        },
                                        "description": "Lista paginada. Filtros via `q[col][operator]=value` (ver List Query Parameters da collection Guper)."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Lista paginada. Filtros via `q[col][operator]=value` (ver List Query Parameters da collection Guper)."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        { \"id\": 1, \"parentId\": null, \"name\": \"Diretoria\", \"description\": null, \"data\": null, \"createdAt\": \"2026-04-24 10:00:00\", \"updatedAt\": \"2026-04-24 10:00:00\" },\n        { \"id\": 2, \"parentId\": 1,    \"name\": \"Marketing\", \"description\": null, \"data\": null, \"createdAt\": \"2026-04-24 10:01:00\", \"updatedAt\": \"2026-04-24 10:01:00\" },\n        { \"id\": 3, \"parentId\": 1,    \"name\": \"Comercial\", \"description\": null, \"data\": null, \"createdAt\": \"2026-04-24 10:02:00\", \"updatedAt\": \"2026-04-24 10:02:00\" }\n    ],\n    \"total\": 3,\n    \"page\": 1,\n    \"entries\": 50\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Subtree (a partir de uma área)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{id}}/tree",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area",
                                                "{{id}}",
                                                "tree"
                                            ]
                                        },
                                        "description": "Returns the area subtree rooted at the given area ID — the area itself, its child areas and so on recursively."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{id}}/tree",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area",
                                                        "{{id}}",
                                                        "tree"
                                                    ]
                                                },
                                                "description": "Returns the area subtree rooted at the given area ID — the area itself, its child areas and so on recursively."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 2, \"parentId\": 1, \"name\": \"Marketing\", \"depth\": 0,\n    \"children\": [\n        { \"id\": 4, \"parentId\": 2, \"name\": \"SEO\",         \"depth\": 1, \"children\": [] },\n        { \"id\": 5, \"parentId\": 2, \"name\": \"Performance\", \"depth\": 1, \"children\": [] }\n    ]\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Tree (organograma completo)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area/tree",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area",
                                                "tree"
                                            ]
                                        },
                                        "description": "Retorna todas as raízes e descendentes em formato aninhado, via CTE recursiva\n(MySQL 8). Cada nó traz seus `children` já populados.\n\nSe quiser apenas o sub-tree de uma área específica, use\n`GET /api/register/team/area/{id}/tree`."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area/tree",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area",
                                                        "tree"
                                                    ]
                                                },
                                                "description": "Retorna todas as raízes e descendentes em formato aninhado, via CTE recursiva\n(MySQL 8). Cada nó traz seus `children` já populados.\n\nSe quiser apenas o sub-tree de uma área específica, use\n`GET /api/register/team/area/{id}/tree`."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"id\": 1, \"parentId\": null, \"name\": \"Diretoria\", \"description\": null, \"data\": null, \"depth\": 0,\n        \"children\": [\n            { \"id\": 2, \"parentId\": 1, \"name\": \"Marketing\", \"depth\": 1, \"children\": [\n                { \"id\": 4, \"parentId\": 2, \"name\": \"SEO\",         \"depth\": 2, \"children\": [] },\n                { \"id\": 5, \"parentId\": 2, \"name\": \"Performance\", \"depth\": 2, \"children\": [] }\n            ] },\n            { \"id\": 3, \"parentId\": 1, \"name\": \"Comercial\", \"depth\": 1, \"children\": [] }\n        ]\n    }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Area",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area"
                                            ]
                                        },
                                        "description": "Atualiza uma área. Envie apenas os campos que mudam — `id` é obrigatório.\nSe `parentId` for incluído (mesmo como `null`), o `CycleGuard` é executado\npara evitar referência circular.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 2,\n    \"name\": \"Marketing Digital\",\n    \"parentId\": 1,\n    \"description\": \"Marketing focado em canais digitais\",\n    \"data\": {\n        \"color\": \"#0a84ff\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Atualiza uma área. Envie apenas os campos que mudam — `id` é obrigatório.\nSe `parentId` for incluído (mesmo como `null`), o `CycleGuard` é executado\npara evitar referência circular.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 2,\n    \"name\": \"Marketing Digital\",\n    \"parentId\": 1,\n    \"description\": \"Marketing focado em canais digitais\",\n    \"data\": {\n        \"color\": \"#0a84ff\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        },
                                        {
                                            "name": "Cycle / parent inválido",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area"
                                                    ]
                                                },
                                                "description": "Atualiza uma área. Envie apenas os campos que mudam — `id` é obrigatório.\nSe `parentId` for incluído (mesmo como `null`), o `CycleGuard` é executado\npara evitar referência circular.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 2,\n    \"name\": \"Marketing Digital\",\n    \"parentId\": 1,\n    \"description\": \"Marketing focado em canais digitais\",\n    \"data\": {\n        \"color\": \"#0a84ff\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"parentId would create a cycle in the area tree\",\n    \"code\": 422\n}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "List Team Members",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/team/",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "team"
                                    ]
                                },
                                "description": "Lists team members (users and collaborators) with pagination, search, position info and setup status. Uses the standard LliureCore query params convention (`q[col][operator]=value`). Includes computed fields: each member's current position (from team_member/team_position) and setup completion status."
                            },
                            "response": [
                                {
                                    "name": "Paginated list with counts and position/setup data.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team"
                                            ]
                                        },
                                        "description": "Lists team members (users and collaborators) with pagination, search, position info and setup status. Uses the standard LliureCore query params convention (`q[col][operator]=value`). Includes computed fields: each member's current position (from team_member/team_position) and setup completion status."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        {\n            \"id\": 123,\n            \"name\": \"John Doe\",\n            \"email\": \"john@example.com\",\n            \"countryCallingCode\": 55,\n            \"cellphone\": \"11999999999\",\n            \"isUser\": 1,\n            \"isCollaborator\": 0,\n            \"language\": \"pt_BR\",\n            \"createdAt\": \"2026-01-15 10:30:00\",\n            \"position\": { \"id\": 5, \"name\": \"Regional Manager\" },\n            \"setupComplete\": true\n        }\n    ],\n    \"total\": 487,\n    \"counts\": {\n        \"all\": 487,\n        \"users\": 120,\n        \"nonUsers\": 367,\n        \"pendingSetup\": 45\n    },\n    \"pagination\": {\n        \"entries\": 20,\n        \"totalPages\": 25,\n        \"currentPage\": 1,\n        \"isInitial\": true,\n        \"isEnd\": false,\n        \"totalPrevPages\": 0,\n        \"totalNextPages\": 24\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Position",
                            "item": [
                                {
                                    "name": "By Area (cargos da área)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{areaId}}/position",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area",
                                                "{{areaId}}",
                                                "position"
                                            ]
                                        },
                                        "description": "Lista flat de todos os cargos da área (não recursivo). Para a estrutura\nhierárquica completa, use o endpoint **Tree**."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{areaId}}/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area",
                                                        "{{areaId}}",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Lista flat de todos os cargos da área (não recursivo). Para a estrutura\nhierárquica completa, use o endpoint **Tree**."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    { \"id\": 10, \"areaId\": 2, \"parentId\": null, \"name\": \"Diretor de Marketing\", \"description\": null, \"data\": null },\n    { \"id\": 11, \"areaId\": 2, \"parentId\": 10,   \"name\": \"Gerente de Performance\", \"description\": null, \"data\": null },\n    { \"id\": 12, \"areaId\": 2, \"parentId\": 11,   \"name\": \"Analista de SEO\",        \"description\": null, \"data\": null }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Create Position",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "position"
                                            ]
                                        },
                                        "description": "Cria um cargo dentro de uma área. Obrigatórios: `areaId`, `name`.\n\nSe `parentId` for informado, deve referenciar um cargo da **mesma** `areaId` —\no `CycleGuard` valida tanto a hierarquia quanto a integridade área↔cargo.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"areaId\": 2,\n    \"name\": \"Analista de SEO\",\n    \"parentId\": 11,\n    \"description\": \"Responsável por SEO orgânico\",\n    \"data\": null\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Cria um cargo dentro de uma área. Obrigatórios: `areaId`, `name`.\n\nSe `parentId` for informado, deve referenciar um cargo da **mesma** `areaId` —\no `CycleGuard` valida tanto a hierarquia quanto a integridade área↔cargo.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"areaId\": 2,\n    \"name\": \"Analista de SEO\",\n    \"parentId\": 11,\n    \"description\": \"Responsável por SEO orgânico\",\n    \"data\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 12,\n    \"areaId\": 2,\n    \"parentId\": 11,\n    \"name\": \"Analista de SEO\",\n    \"description\": \"Responsável por SEO orgânico\",\n    \"data\": null\n}"
                                        },
                                        {
                                            "name": "Parent de outra área ou ciclo na cadeia",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Cria um cargo dentro de uma área. Obrigatórios: `areaId`, `name`.\n\nSe `parentId` for informado, deve referenciar um cargo da **mesma** `areaId` —\no `CycleGuard` valida tanto a hierarquia quanto a integridade área↔cargo.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"areaId\": 2,\n    \"name\": \"Analista de SEO\",\n    \"parentId\": 11,\n    \"description\": \"Responsável por SEO orgânico\",\n    \"data\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"parentId must belong to the same areaId\",\n    \"code\": 422\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete Position",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "position"
                                            ]
                                        },
                                        "description": "Remove um cargo. Falha (FK RESTRICT) se houver vínculos (`team_member`)\napontando para ele — encerre os vínculos antes ou mova-os de cargo.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 12\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Remove um cargo. Falha (FK RESTRICT) se houver vínculos (`team_member`)\napontando para ele — encerre os vínculos antes ou mova-os de cargo.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 12\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        },
                                        {
                                            "name": "Constraint — cargo referenciado por vínculos",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Remove um cargo. Falha (FK RESTRICT) se houver vínculos (`team_member`)\napontando para ele — encerre os vínculos antes ou mova-os de cargo.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 12\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 409,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"Cannot delete or update a parent row: a foreign key constraint fails\",\n    \"code\": 409\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Position",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/position/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "position",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single the position matching the given identifier."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single the position matching the given identifier."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List Positions",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "position"
                                            ]
                                        },
                                        "description": "Returns a paginated list of positions."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of positions."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        { \"id\": 10, \"areaId\": 2, \"parentId\": null, \"name\": \"Diretor de Marketing\" },\n        { \"id\": 11, \"areaId\": 2, \"parentId\": 10,   \"name\": \"Gerente de Performance\" },\n        { \"id\": 12, \"areaId\": 2, \"parentId\": 11,   \"name\": \"Analista de SEO\" }\n    ],\n    \"total\": 3, \"page\": 1, \"entries\": 50\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Tree (cadeia de cargos da área)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{areaId}}/position/tree",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "area",
                                                "{{areaId}}",
                                                "position",
                                                "tree"
                                            ]
                                        },
                                        "description": "Returns the tree of positions within an area — useful to render an area's organisational chart."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/area/{{areaId}}/position/tree",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "area",
                                                        "{{areaId}}",
                                                        "position",
                                                        "tree"
                                                    ]
                                                },
                                                "description": "Returns the tree of positions within an area — useful to render an area's organisational chart."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"id\": 10, \"areaId\": 2, \"parentId\": null, \"name\": \"Diretor de Marketing\", \"depth\": 0,\n        \"children\": [\n            { \"id\": 11, \"areaId\": 2, \"parentId\": 10, \"name\": \"Gerente de Performance\", \"depth\": 1, \"children\": [\n                { \"id\": 12, \"areaId\": 2, \"parentId\": 11, \"name\": \"Analista de SEO\", \"depth\": 2, \"children\": [] }\n            ] }\n        ]\n    }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Position",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "position"
                                            ]
                                        },
                                        "description": "Atualiza um cargo. Envie apenas os campos que mudam — `id` é obrigatório.\n\nSe `parentId` for incluído (mesmo como `null`), o `CycleGuard` é executado.\nSe `areaId` não vier, o `areaId` atual do cargo é usado para validar o pai.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 12,\n    \"areaId\": 2,\n    \"name\": \"Analista de SEO Sênior\",\n    \"parentId\": 11,\n    \"description\": \"Responsável por SEO orgânico e técnico\",\n    \"data\": null\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Atualiza um cargo. Envie apenas os campos que mudam — `id` é obrigatório.\n\nSe `parentId` for incluído (mesmo como `null`), o `CycleGuard` é executado.\nSe `areaId` não vier, o `areaId` atual do cargo é usado para validar o pai.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 12,\n    \"areaId\": 2,\n    \"name\": \"Analista de SEO Sênior\",\n    \"parentId\": 11,\n    \"description\": \"Responsável por SEO orgânico e técnico\",\n    \"data\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        },
                                        {
                                            "name": "Parent de outra área ou ciclo na cadeia",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/position",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "position"
                                                    ]
                                                },
                                                "description": "Atualiza um cargo. Envie apenas os campos que mudam — `id` é obrigatório.\n\nSe `parentId` for incluído (mesmo como `null`), o `CycleGuard` é executado.\nSe `areaId` não vier, o `areaId` atual do cargo é usado para validar o pai.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 12,\n    \"areaId\": 2,\n    \"name\": \"Analista de SEO Sênior\",\n    \"parentId\": 11,\n    \"description\": \"Responsável por SEO orgânico e técnico\",\n    \"data\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"parentId must belong to the same areaId\",\n    \"code\": 422\n}"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Vínculos (Members)",
                            "item": [
                                {
                                    "name": "By Area (ativos na área + sub-áreas)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member/by/area/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member",
                                                "by",
                                                "area",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Retorna os vínculos **ativos** da área e de todas as suas sub-áreas\n(CTE recursiva). Cada item já vem com `positionName` e `areaId` para\no admin renderizar sem precisar de chamadas adicionais.\n\nPara listar apenas os cargos da área (sem pessoas), use\n`/api/register/team/area/{areaId}/position`."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/by/area/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "by",
                                                        "area",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Retorna os vínculos **ativos** da área e de todas as suas sub-áreas\n(CTE recursiva). Cada item já vem com `positionName` e `areaId` para\no admin renderizar sem precisar de chamadas adicionais.\n\nPara listar apenas os cargos da área (sem pessoas), use\n`/api/register/team/area/{areaId}/position`."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    { \"id\": 7, \"personId\": 99, \"positionId\": 12, \"reportsTo\": 5,    \"startedAt\": \"2026-04-24\", \"endedAt\": null, \"data\": null, \"areaId\": 2, \"positionName\": \"Analista de SEO\" },\n    { \"id\": 5, \"personId\": 50, \"positionId\": 11, \"reportsTo\": null, \"startedAt\": \"2025-08-01\", \"endedAt\": null, \"data\": null, \"areaId\": 2, \"positionName\": \"Gerente de Performance\" }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "By Person (todos os vínculos da pessoa)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member/by/person/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member",
                                                "by",
                                                "person",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Retorna o histórico completo de vínculos de uma pessoa — ativos\n(`endedAt IS NULL`) e encerrados — em ordem de cadastro."
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/by/person/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "by",
                                                        "person",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Retorna o histórico completo de vínculos de uma pessoa — ativos\n(`endedAt IS NULL`) e encerrados — em ordem de cadastro."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    { \"id\": 4, \"personId\": 99, \"positionId\": 11, \"reportsTo\": null, \"startedAt\": \"2025-01-10\", \"endedAt\": \"2026-04-24\", \"data\": null },\n    { \"id\": 7, \"personId\": 99, \"positionId\": 12, \"reportsTo\": 5,    \"startedAt\": \"2026-04-24\", \"endedAt\": null,         \"data\": null }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "By Position (ativos no cargo)",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member/by/position/{{positionId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member",
                                                "by",
                                                "position",
                                                "{{positionId}}"
                                            ]
                                        },
                                        "description": "Returns the members currently active in the given position."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/by/position/{{positionId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "by",
                                                        "position",
                                                        "{{positionId}}"
                                                    ]
                                                },
                                                "description": "Returns the members currently active in the given position."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Create / Activate",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member"
                                            ]
                                        },
                                        "description": "Cria um vínculo entre uma pessoa e um cargo. **Comportamento atômico (transação):**\n\n1. Se já existe vínculo ativo da `personId`, ele é encerrado (`endedAt = startedAt`).\n2. Cria o novo vínculo.\n3. Garante `person.isCollaborator = 1`.\n\nUse para contratar ou trocar de cargo. Para encerrar sem substituição, use `End`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"personId\": 99,\n    \"positionId\": 12,\n    \"reportsTo\": 5,\n    \"startedAt\": \"2026-04-24\",\n    \"data\": null\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member"
                                                    ]
                                                },
                                                "description": "Cria um vínculo entre uma pessoa e um cargo. **Comportamento atômico (transação):**\n\n1. Se já existe vínculo ativo da `personId`, ele é encerrado (`endedAt = startedAt`).\n2. Cria o novo vínculo.\n3. Garante `person.isCollaborator = 1`.\n\nUse para contratar ou trocar de cargo. Para encerrar sem substituição, use `End`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"personId\": 99,\n    \"positionId\": 12,\n    \"reportsTo\": 5,\n    \"startedAt\": \"2026-04-24\",\n    \"data\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 7,\n    \"personId\": 99,\n    \"positionId\": 12,\n    \"reportsTo\": 5,\n    \"startedAt\": \"2026-04-24\",\n    \"endedAt\": null,\n    \"data\": null\n}"
                                        },
                                        {
                                            "name": "personId / positionId / reportsTo inválido",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member"
                                                    ]
                                                },
                                                "description": "Cria um vínculo entre uma pessoa e um cargo. **Comportamento atômico (transação):**\n\n1. Se já existe vínculo ativo da `personId`, ele é encerrado (`endedAt = startedAt`).\n2. Cria o novo vínculo.\n3. Garante `person.isCollaborator = 1`.\n\nUse para contratar ou trocar de cargo. Para encerrar sem substituição, use `End`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"personId\": 99,\n    \"positionId\": 12,\n    \"reportsTo\": 5,\n    \"startedAt\": \"2026-04-24\",\n    \"data\": null\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"personId not found in this organization\",\n    \"code\": 422\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete (sem histórico)",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member"
                                            ]
                                        },
                                        "description": "Apaga o registro de vínculo **definitivamente**. Use só para corrigir erros\nde cadastro. Para encerrar mantendo histórico (ex: demissão), use **End**.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 7\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member"
                                                    ]
                                                },
                                                "description": "Apaga o registro de vínculo **definitivamente**. Use só para corrigir erros\nde cadastro. Para encerrar mantendo histórico (ex: demissão), use **End**.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 7\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                },
                                {
                                    "name": "End (encerrar mantendo histórico)",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member/{{id}}/end",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member",
                                                "{{id}}",
                                                "end"
                                            ]
                                        },
                                        "description": "Encerra o vínculo (saída/demissão) preenchendo `endedAt`. Diferente do DELETE,\no registro é mantido para auditoria/histórico.\n\nBody é opcional — se omitir `endedAt`, usa hoje. `endedAt` não pode ser anterior\na `startedAt`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"endedAt\": \"2026-04-24\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Successful Response",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/{{id}}/end",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "{{id}}",
                                                        "end"
                                                    ]
                                                },
                                                "description": "Encerra o vínculo (saída/demissão) preenchendo `endedAt`. Diferente do DELETE,\no registro é mantido para auditoria/histórico.\n\nBody é opcional — se omitir `endedAt`, usa hoje. `endedAt` não pode ser anterior\na `startedAt`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"endedAt\": \"2026-04-24\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 7,\n    \"personId\": 99,\n    \"positionId\": 12,\n    \"reportsTo\": 5,\n    \"startedAt\": \"2026-04-24\",\n    \"endedAt\": \"2026-04-24\",\n    \"data\": null\n}"
                                        },
                                        {
                                            "name": "Vínculo não encontrado nesta organização",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/{{id}}/end",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "{{id}}",
                                                        "end"
                                                    ]
                                                },
                                                "description": "Encerra o vínculo (saída/demissão) preenchendo `endedAt`. Diferente do DELETE,\no registro é mantido para auditoria/histórico.\n\nBody é opcional — se omitir `endedAt`, usa hoje. `endedAt` não pode ser anterior\na `startedAt`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"endedAt\": \"2026-04-24\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"member not found in this organization\",\n    \"code\": 404\n}"
                                        },
                                        {
                                            "name": "Já encerrado ou data inválida",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/{{id}}/end",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "{{id}}",
                                                        "end"
                                                    ]
                                                },
                                                "description": "Encerra o vínculo (saída/demissão) preenchendo `endedAt`. Diferente do DELETE,\no registro é mantido para auditoria/histórico.\n\nBody é opcional — se omitir `endedAt`, usa hoje. `endedAt` não pode ser anterior\na `startedAt`.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"endedAt\": \"2026-04-24\"\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"message\": \"member is already ended\",\n    \"code\": 422\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Team Member",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single the member matching the given identifier."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single the member matching the given identifier."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "List Team Members",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member"
                                            ]
                                        },
                                        "description": "Returns a paginated list of members."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member"
                                                    ]
                                                },
                                                "description": "Returns a paginated list of members."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Team Member",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "team",
                                                "member"
                                            ]
                                        },
                                        "description": "Atualiza campos de um vínculo existente. Use **apenas** para corrigir\n`reportsTo`, `data`, `startedAt`. Para trocar de cargo, use **Create / Activate**\n(que encerra o vínculo anterior automaticamente).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 7,\n    \"reportsTo\": 6,\n    \"startedAt\": \"2026-04-24\",\n    \"data\": {\n        \"note\": \"transferido para gerente novo\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/team/member",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "team",
                                                        "member"
                                                    ]
                                                },
                                                "description": "Atualiza campos de um vínculo existente. Use **apenas** para corrigir\n`reportsTo`, `data`, `startedAt`. Para trocar de cargo, use **Create / Activate**\n(que encerra o vínculo anterior automaticamente).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 7,\n    \"reportsTo\": 6,\n    \"startedAt\": \"2026-04-24\",\n    \"data\": {\n        \"note\": \"transferido para gerente novo\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Tier",
                    "item": [
                        {
                            "name": "Balance",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "{{personId}}",
                                        "tier"
                                    ]
                                },
                                "description": "Returns the current tier balance for a person — active points, current level id, next level name and how many points are missing to reach it.\nThe current level **name** is not in the payload; resolve it from the tier configuration using `levelId` (see [Tier config — Read](../config/read))."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier"
                                            ]
                                        },
                                        "description": "Returns the current tier balance for a person — active points, current level id, next level name and how many points are missing to reach it.\nThe current level **name** is not in the payload; resolve it from the tier configuration using `levelId` (see [Tier config — Read](../config/read))."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"person\":       44,\n    \"activePoints\": 2350,\n    \"levelId\":      2,\n    \"nextLevel\":    \"Gold\",\n    \"pointsToNext\": 2650\n}"
                                },
                                {
                                    "name": "No tier yet",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier"
                                            ]
                                        },
                                        "description": "Returns the current tier balance for a person — active points, current level id, next level name and how many points are missing to reach it.\nThe current level **name** is not in the payload; resolve it from the tier configuration using `levelId` (see [Tier config — Read](../config/read))."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"person\": 44, \"activePoints\": 0 }"
                                }
                            ]
                        },
                        {
                            "name": "Tier config",
                            "item": [
                                {
                                    "name": "Create Config",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tier/config",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tier",
                                                "config"
                                            ]
                                        },
                                        "description": "Creates a new tier configuration. Each organization can run more than one program in parallel (e.g. customer tier + collaborator tier).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Programa Guper\",\n    \"levels\": [\n        {\n            \"name\": \"Silver\",\n            \"minPoints\": 1000\n        }\n    ],\n    \"sources\": \"{\\\"rewardCampaign\\\": {\\\"multiplier\\\": 1, \\\"expiresInDays\\\": 365, \\\"campaigns\\\": [12, 40]}}\",\n    \"isActive\": true,\n    \"autoEnrollOnOptIn\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Created",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config"
                                                    ]
                                                },
                                                "description": "Creates a new tier configuration. Each organization can run more than one program in parallel (e.g. customer tier + collaborator tier).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Programa Guper\",\n    \"levels\": [\n        {\n            \"name\": \"Silver\",\n            \"minPoints\": 1000\n        }\n    ],\n    \"sources\": \"{\\\"rewardCampaign\\\": {\\\"multiplier\\\": 1, \\\"expiresInDays\\\": 365, \\\"campaigns\\\": [12, 40]}}\",\n    \"isActive\": true,\n    \"autoEnrollOnOptIn\": true\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\":        2,\n    \"name\":      \"Colaboradores Guper\",\n    \"isActive\":  true,\n    \"createdAt\": \"2026-05-01T12:34:56-03:00\"\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete Config",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tier",
                                                "config",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Removes a tier configuration. Existing person tier ledgers tied to it are kept; only the configuration is dropped."
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Removes a tier configuration. Existing person tier ledgers tied to it are kept; only the configuration is dropped."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        },
                                        {
                                            "name": "Missing path parameter",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Removes a tier configuration. Existing person tier ledgers tied to it are kept; only the configuration is dropped."
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"bad_request\", \"message\": \"The 'id' path parameter is required\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "List Tier Configs — loyalty levels (tiers), point ranges & benefits",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tier/config",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tier",
                                                "config"
                                            ]
                                        },
                                        "description": "Returns every tier program configuration belonging to the organization."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config"
                                                    ]
                                                },
                                                "description": "Returns every tier program configuration belonging to the organization."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"id\":         1,\n        \"name\":       \"Programa Guper\",\n        \"levels\": [\n            { \"id\": 1, \"name\": \"Bronze\",   \"minPoints\": 0     },\n            { \"id\": 2, \"name\": \"Silver\",   \"minPoints\": 1000  },\n            { \"id\": 3, \"name\": \"Gold\",     \"minPoints\": 5000  },\n            { \"id\": 4, \"name\": \"Platinum\", \"minPoints\": 15000 }\n        ],\n        \"sources\": [\n            { \"source\": \"rewardCampaign\", \"expiresInDays\": 365 },\n            { \"source\": \"manual\",         \"expiresInDays\": null }\n        ],\n        \"isActive\":          true,\n        \"autoEnrollOnOptIn\": false,\n        \"createdAt\":         \"2026-01-15T09:00:00-03:00\",\n        \"updatedAt\":         \"2026-04-20T11:30:00-03:00\"\n    }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Get Config",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tier",
                                                "config",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single tier configuration by ID."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single tier configuration by ID."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\":       1,\n    \"name\":     \"Programa Guper\",\n    \"levels\": [\n        { \"id\": 1, \"name\": \"Bronze\",   \"minPoints\": 0    },\n        { \"id\": 2, \"name\": \"Silver\",   \"minPoints\": 1000 },\n        { \"id\": 3, \"name\": \"Gold\",     \"minPoints\": 5000 }\n    ],\n    \"sources\": [\n        { \"source\": \"rewardCampaign\", \"expiresInDays\": 365 }\n    ],\n    \"isActive\": true\n}"
                                        },
                                        {
                                            "name": "Not found",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Returns a single tier configuration by ID."
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"not_found\", \"message\": \"Tier config not found\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update Config",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "tier",
                                                "config",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Updates an existing tier configuration. Only fields included in the body are changed; level/source arrays are replaced wholesale.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Programa Guper 2026\",\n    \"levels\": \"<levels>\",\n    \"sources\": \"<sources>\",\n    \"isActive\": false,\n    \"autoEnrollOnOptIn\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Updates an existing tier configuration. Only fields included in the body are changed; level/source arrays are replaced wholesale.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Programa Guper 2026\",\n    \"levels\": \"<levels>\",\n    \"sources\": \"<sources>\",\n    \"isActive\": false,\n    \"autoEnrollOnOptIn\": true\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"affectedRows\": 1 }"
                                        },
                                        {
                                            "name": "Missing path parameter",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/register/tier/config/{{id}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "register",
                                                        "tier",
                                                        "config",
                                                        "{{id}}"
                                                    ]
                                                },
                                                "description": "Updates an existing tier configuration. Only fields included in the body are changed; level/source arrays are replaced wholesale.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Programa Guper 2026\",\n    \"levels\": \"<levels>\",\n    \"sources\": \"<sources>\",\n    \"isActive\": false,\n    \"autoEnrollOnOptIn\": true\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Bad Request",
                                            "code": 400,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"bad_request\", \"message\": \"The 'id' path parameter is required\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Flow",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/flow",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "{{personId}}",
                                        "tier",
                                        "flow"
                                    ]
                                },
                                "description": "Returns the full tier-points ledger for a person — every credit/debit with its source, expiration and description. Use to render a \"tier history\" view."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/flow",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier",
                                                "flow"
                                            ]
                                        },
                                        "description": "Returns the full tier-points ledger for a person — every credit/debit with its source, expiration and description. Use to render a \"tier history\" view."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "[\n    {\n        \"id\":          501,\n        \"person\":      44,\n        \"tierConfig\":  1,\n        \"source\":      \"rewardCampaign\",\n        \"sourceId\":    \"tx_demo_a1b2c3d4\",\n        \"operation\":   \"credit\",\n        \"points\":      150,\n        \"expireAt\":    \"2027-05-01T00:00:00-03:00\",\n        \"description\": \"Cashback ord_2026_001\",\n        \"createdAt\":   \"2026-05-01T12:34:56-03:00\"\n    },\n    {\n        \"id\":          502,\n        \"person\":      44,\n        \"tierConfig\":  1,\n        \"source\":      \"manual\",\n        \"sourceId\":    \"ops-44-bonus\",\n        \"operation\":   \"credit\",\n        \"points\":      500,\n        \"expireAt\":    null,\n        \"description\": \"Welcome bonus\",\n        \"createdAt\":   \"2026-05-02T09:00:00-03:00\"\n    }\n]"
                                }
                            ]
                        },
                        {
                            "name": "Add points",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/points",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "{{personId}}",
                                        "tier",
                                        "points"
                                    ]
                                },
                                "description": "Adds a tier-points entry to a person. Tier balance and level are recalculated\nimmediately. Use `source: rewardCampaign` (with the `sourceId` of the underlying\ntransaction) when the points come from a loyalty event, or `source: manual`\nfor ops-driven adjustments.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"source\": \"rewardCampaign\",\n    \"sourceId\": \"tx_demo_a1b2c3d4\",\n    \"value\": 150,\n    \"expireAt\": \"2027-05-01T00:00:00-03:00\",\n    \"description\": \"Cashback ord_2026_001\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Points credited",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/points",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier",
                                                "points"
                                            ]
                                        },
                                        "description": "Adds a tier-points entry to a person. Tier balance and level are recalculated\nimmediately. Use `source: rewardCampaign` (with the `sourceId` of the underlying\ntransaction) when the points come from a loyalty event, or `source: manual`\nfor ops-driven adjustments.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"source\": \"rewardCampaign\",\n    \"sourceId\": \"tx_demo_a1b2c3d4\",\n    \"value\": 150,\n    \"expireAt\": \"2027-05-01T00:00:00-03:00\",\n    \"description\": \"Cashback ord_2026_001\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"success\":      true,\n    \"pointsAdded\":  150,\n    \"source\":       \"rewardCampaign\",\n    \"activePoints\": 2350\n}"
                                },
                                {
                                    "name": "Missing required field",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/points",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier",
                                                "points"
                                            ]
                                        },
                                        "description": "Adds a tier-points entry to a person. Tier balance and level are recalculated\nimmediately. Use `source: rewardCampaign` (with the `sourceId` of the underlying\ntransaction) when the points come from a loyalty event, or `source: manual`\nfor ops-driven adjustments.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"source\": \"rewardCampaign\",\n    \"sourceId\": \"tx_demo_a1b2c3d4\",\n    \"value\": 150,\n    \"expireAt\": \"2027-05-01T00:00:00-03:00\",\n    \"description\": \"Cashback ord_2026_001\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"bad_request\", \"message\": \"Missing required field: source\" }"
                                }
                            ]
                        },
                        {
                            "name": "Remove points",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/points/{{sourceId}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "register",
                                        "person",
                                        "{{personId}}",
                                        "tier",
                                        "points",
                                        "{{sourceId}}"
                                    ]
                                },
                                "description": "Reverses a tier-points entry. Use this to undo points credited earlier — for\nexample when the underlying loyalty transaction was cancelled. The reversal\nkeeps an audit row in Flow (`operation: debit`) so the history stays auditable.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"source\": \"rewardCampaign\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Points removed",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/points/{{sourceId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier",
                                                "points",
                                                "{{sourceId}}"
                                            ]
                                        },
                                        "description": "Reverses a tier-points entry. Use this to undo points credited earlier — for\nexample when the underlying loyalty transaction was cancelled. The reversal\nkeeps an audit row in Flow (`operation: debit`) so the history stays auditable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"source\": \"rewardCampaign\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"success\":        true,\n    \"pointsCanceled\": 150,\n    \"activePoints\":   2200\n}"
                                },
                                {
                                    "name": "Source entry not found",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/register/person/{{personId}}/tier/points/{{sourceId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "register",
                                                "person",
                                                "{{personId}}",
                                                "tier",
                                                "points",
                                                "{{sourceId}}"
                                            ]
                                        },
                                        "description": "Reverses a tier-points entry. Use this to undo points credited earlier — for\nexample when the underlying loyalty transaction was cancelled. The reversal\nkeeps an audit row in Flow (`operation: debit`) so the history stays auditable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"source\": \"rewardCampaign\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"not_found\", \"message\": \"No tier-points entry matches the given personId + sourceId\" }"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "name": "Sender",
            "item": [
                {
                    "name": "Send admin message",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/sender/admin-message/send",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "sender",
                                "admin-message",
                                "send"
                            ]
                        },
                        "description": "Drops a transactional message into `message_process_queue` in\n`admin` mode. The Process Worker picks it up via `AdminStorager`,\nbinds it to the configured `AdminMessage::SEQUENCE`, and delivers\nit through the matching template for the requested locale.\n\nUse cases: account-management notifications, internal alerts,\ncustomer-service-initiated transactional sends — anything that\nsidesteps the regular sequence rules.",
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"slug\": \"password.reset\",\n    \"locale\": \"pt-BR\",\n    \"person\": 47,\n    \"data\": \"<data>\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Enqueued",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/admin-message/send",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "admin-message",
                                        "send"
                                    ]
                                },
                                "description": "Drops a transactional message into `message_process_queue` in\n`admin` mode. The Process Worker picks it up via `AdminStorager`,\nbinds it to the configured `AdminMessage::SEQUENCE`, and delivers\nit through the matching template for the requested locale.\n\nUse cases: account-management notifications, internal alerts,\ncustomer-service-initiated transactional sends — anything that\nsidesteps the regular sequence rules.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"password.reset\",\n    \"locale\": \"pt-BR\",\n    \"person\": 47,\n    \"data\": \"<data>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{ \"error\": false, \"id\": 8123 }"
                        },
                        {
                            "name": "Missing required field",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/admin-message/send",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "admin-message",
                                        "send"
                                    ]
                                },
                                "description": "Drops a transactional message into `message_process_queue` in\n`admin` mode. The Process Worker picks it up via `AdminStorager`,\nbinds it to the configured `AdminMessage::SEQUENCE`, and delivers\nit through the matching template for the requested locale.\n\nUse cases: account-management notifications, internal alerts,\ncustomer-service-initiated transactional sends — anything that\nsidesteps the regular sequence rules.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"password.reset\",\n    \"locale\": \"pt-BR\",\n    \"person\": 47,\n    \"data\": \"<data>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "status": "Bad Request",
                            "code": 400,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": ""
                        }
                    ]
                },
                {
                    "name": "Cron",
                    "item": [
                        {
                            "name": "Cron: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/cron/list",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "cron",
                                        "list"
                                    ]
                                },
                                "description": "Returns every `ll_cronjob` row for this service with normalized\ntimestamps (`next_execution` / `last_execution` converted from UTC\nto America/Sao_Paulo wall clock to match the convention used by the\nother services) plus `seconds_since_last_execution`. Consumed by\nthe Guper Dashboards service.\n\nAuth: this endpoint runs under origin signature only — no user token."
                            },
                            "response": [
                                {
                                    "name": "List of crons",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/cron/list",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "cron",
                                                "list"
                                            ]
                                        },
                                        "description": "Returns every `ll_cronjob` row for this service with normalized\ntimestamps (`next_execution` / `last_execution` converted from UTC\nto America/Sao_Paulo wall clock to match the convention used by the\nother services) plus `seconds_since_last_execution`. Consumed by\nthe Guper Dashboards service.\n\nAuth: this endpoint runs under origin signature only — no user token."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"service\":     \"sender\",\n    \"server_time\": \"2026-05-08T12:00:00-03:00\",\n    \"crons\": [\n        {\n            \"id\": 7, \"group\": 1, \"name\": \"dispatcher\", \"description\": \"Sends pending messages\",\n            \"path\": \"cron/Dispatcher.php\", \"status\": 1, \"is_active\": 1, \"attempts\": 0,\n            \"id_next_cron\": null, \"interval\": \"60\",\n            \"next_execution\": \"2026-05-08 12:01:00\",\n            \"last_execution\": \"2026-05-08 12:00:00\",\n            \"seconds_since_last_execution\": 0\n        }\n    ]\n}"
                                }
                            ]
                        },
                        {
                            "name": "Cron: Reset",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/cron/{{id}}/reset",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "cron",
                                        "{{id}}",
                                        "reset"
                                    ]
                                },
                                "description": "Resets a stuck cron — sets `status = 1` and `attempts = 0` on the\n`ll_cronjob` row so the scheduler picks it up on the next tick.\nUsed when a worker died holding the job and the watchdog couldn't\nrecover it automatically.\n\nAuth: origin signature only."
                            },
                            "response": [
                                {
                                    "name": "Reset",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/cron/{{id}}/reset",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "cron",
                                                "{{id}}",
                                                "reset"
                                            ]
                                        },
                                        "description": "Resets a stuck cron — sets `status = 1` and `attempts = 0` on the\n`ll_cronjob` row so the scheduler picks it up on the next tick.\nUsed when a worker died holding the job and the watchdog couldn't\nrecover it automatically.\n\nAuth: origin signature only."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"service\": \"sender\", \"id\": 7, \"reset\": true }"
                                },
                                {
                                    "name": "invalid id",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/cron/{{id}}/reset",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "cron",
                                                "{{id}}",
                                                "reset"
                                            ]
                                        },
                                        "description": "Resets a stuck cron — sets `status = 1` and `attempts = 0` on the\n`ll_cronjob` row so the scheduler picks it up on the next tick.\nUsed when a worker died holding the job and the watchdog couldn't\nrecover it automatically.\n\nAuth: origin signature only."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "cron not found",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/cron/{{id}}/reset",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "cron",
                                                "{{id}}",
                                                "reset"
                                            ]
                                        },
                                        "description": "Resets a stuck cron — sets `status = 1` and `attempts = 0` on the\n`ll_cronjob` row so the scheduler picks it up on the next tick.\nUsed when a worker died holding the job and the watchdog couldn't\nrecover it automatically.\n\nAuth: origin signature only."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "External provider",
                    "item": [
                        {
                            "name": "Setup",
                            "item": [
                                {
                                    "name": "Create External Provider",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "external-provider"
                                            ]
                                        },
                                        "description": "Registers an External Provider (webhook) for the organization. The Sender will POST messages to the\nconfigured URL whenever a template that points to this provider is dispatched.\n\nThe endpoint resolves the `provider_source` of type `external` automatically — clients only need to\nsend `name`, `default` and the `data` block describing the webhook URL and authentication.\n\n## Auth methods\n\n| Method | Header sent on each call |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header |\n\nSee [Webhook payload](/api-reference/sender/external-provider/webhook-payload-exemplo-completo) for\nthe request shape your endpoint should expect.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"name\": \"Meu Webhook CRM\",\n    \"default\": false,\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-abc123...\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "External provider created.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Registers an External Provider (webhook) for the organization. The Sender will POST messages to the\nconfigured URL whenever a template that points to this provider is dispatched.\n\nThe endpoint resolves the `provider_source` of type `external` automatically — clients only need to\nsend `name`, `default` and the `data` block describing the webhook URL and authentication.\n\n## Auth methods\n\n| Method | Header sent on each call |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header |\n\nSee [Webhook payload](/api-reference/sender/external-provider/webhook-payload-exemplo-completo) for\nthe request shape your endpoint should expect.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Meu Webhook CRM\",\n    \"default\": false,\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-abc123...\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 42,\n    \"name\": \"Meu Webhook CRM\",\n    \"default\": false,\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-abc123...\"\n    }\n}"
                                        },
                                        {
                                            "name": "`data.url` is missing or `name`/`data` not sent.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Registers an External Provider (webhook) for the organization. The Sender will POST messages to the\nconfigured URL whenever a template that points to this provider is dispatched.\n\nThe endpoint resolves the `provider_source` of type `external` automatically — clients only need to\nsend `name`, `default` and the `data` block describing the webhook URL and authentication.\n\n## Auth methods\n\n| Method | Header sent on each call |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header |\n\nSee [Webhook payload](/api-reference/sender/external-provider/webhook-payload-exemplo-completo) for\nthe request shape your endpoint should expect.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Meu Webhook CRM\",\n    \"default\": false,\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-abc123...\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"Field data.url is required\" }"
                                        },
                                        {
                                            "name": "External provider type is not registered in `provider_source`.",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Registers an External Provider (webhook) for the organization. The Sender will POST messages to the\nconfigured URL whenever a template that points to this provider is dispatched.\n\nThe endpoint resolves the `provider_source` of type `external` automatically — clients only need to\nsend `name`, `default` and the `data` block describing the webhook URL and authentication.\n\n## Auth methods\n\n| Method | Header sent on each call |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header |\n\nSee [Webhook payload](/api-reference/sender/external-provider/webhook-payload-exemplo-completo) for\nthe request shape your endpoint should expect.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"name\": \"Meu Webhook CRM\",\n    \"default\": false,\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-abc123...\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"External provider type not registered in provider_source\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Delete External Provider Setup",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "external-provider"
                                            ]
                                        },
                                        "description": "Removes an External Provider setup. Templates associated with it\nfall back to the organization default (if one exists).\n\nThe route is `DELETE /api/sender/external-provider` — the `id`\ntravels in the JSON body, not the URL (the prior `/{providerSettingId}`\npath documented here didn't match the actual router).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 5\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Removed",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Removes an External Provider setup. Templates associated with it\nfall back to the organization default (if one exists).\n\nThe route is `DELETE /api/sender/external-provider` — the `id`\ntravels in the JSON body, not the URL (the prior `/{providerSettingId}`\npath documented here didn't match the actual router).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 5\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"success\": true }"
                                        },
                                        {
                                            "name": "Setup not found",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Removes an External Provider setup. Templates associated with it\nfall back to the organization default (if one exists).\n\nThe route is `DELETE /api/sender/external-provider` — the `id`\ntravels in the JSON body, not the URL (the prior `/{providerSettingId}`\npath documented here didn't match the actual router).",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 5\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"not_found\", \"message\": \"External provider not found\" }"
                                        }
                                    ]
                                },
                                {
                                    "name": "List External Providers",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "external-provider"
                                            ]
                                        },
                                        "description": "Lista todos os provider settings da organizacao.\n\nRetorna todos os tipos (SMTP, Twilio, External, etc). Cada item inclui os dados de configuracao completos."
                                    },
                                    "response": [
                                        {
                                            "name": "Success",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Lista todos os provider settings da organizacao.\n\nRetorna todos os tipos (SMTP, Twilio, External, etc). Cada item inclui os dados de configuracao completos."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "[\n    {\n        \"id\": 42,\n        \"organization\": \"xpto\",\n        \"provider\": 7,\n        \"name\": \"Meu Webhook CRM\",\n        \"default\": false,\n        \"data\": {\n            \"url\": \"https://api.meucrm.com/webhooks/messages\",\n            \"authMethod\": \"bearer\",\n            \"authToken\": \"sk-abc123...\"\n        }\n    },\n    {\n        \"id\": 10,\n        \"organization\": \"xpto\",\n        \"provider\": 1,\n        \"name\": \"SMTP Principal\",\n        \"default\": true,\n        \"data\": {\n            \"host\": \"smtp.example.com\",\n            \"username\": \"sender@example.com\"\n        }\n    }\n]"
                                        }
                                    ]
                                },
                                {
                                    "name": "Update External Provider",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "external-provider"
                                            ]
                                        },
                                        "description": "Updates an External Provider previously created in [Create](/api-reference/sender/external-provider/setup/create).\nOnly the fields you want to change need to be sent — `name`, `default` and `data` are individually\noptional but at least one of them is expected together with `id`.\n\nSending `data` replaces the whole `data` object — partial updates inside `data` are not supported.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 42,\n    \"name\": \"Webhook CRM v2\",\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/v2/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-new-token-456...\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "External provider updated.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Updates an External Provider previously created in [Create](/api-reference/sender/external-provider/setup/create).\nOnly the fields you want to change need to be sent — `name`, `default` and `data` are individually\noptional but at least one of them is expected together with `id`.\n\nSending `data` replaces the whole `data` object — partial updates inside `data` are not supported.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 42,\n    \"name\": \"Webhook CRM v2\",\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/v2/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-new-token-456...\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"id\": 42,\n    \"updated\": true\n}"
                                        },
                                        {
                                            "name": "`id` is missing in the body.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Updates an External Provider previously created in [Create](/api-reference/sender/external-provider/setup/create).\nOnly the fields you want to change need to be sent — `name`, `default` and `data` are individually\noptional but at least one of them is expected together with `id`.\n\nSending `data` replaces the whole `data` object — partial updates inside `data` are not supported.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 42,\n    \"name\": \"Webhook CRM v2\",\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/v2/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-new-token-456...\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Unprocessable Entity",
                                            "code": 422,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"Field id is required\" }"
                                        },
                                        {
                                            "name": "External provider does not exist for this organization.",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/external-provider",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "external-provider"
                                                    ]
                                                },
                                                "description": "Updates an External Provider previously created in [Create](/api-reference/sender/external-provider/setup/create).\nOnly the fields you want to change need to be sent — `name`, `default` and `data` are individually\noptional but at least one of them is expected together with `id`.\n\nSending `data` replaces the whole `data` object — partial updates inside `data` are not supported.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"id\": 42,\n    \"name\": \"Webhook CRM v2\",\n    \"data\": {\n        \"url\": \"https://api.meucrm.com/v2/webhooks/messages\",\n        \"authMethod\": \"bearer\",\n        \"authToken\": \"sk-new-token-456...\"\n    }\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"error\": \"External provider setting not found\" }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Webhook payload — full example",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json`."
                                    },
                                    {
                                        "key": "Authorization",
                                        "value": "{{Authorization}}",
                                        "type": "text",
                                        "description": "Set when `data.authMethod` is `bearer` or `basic`. See the table above."
                                    },
                                    {
                                        "key": "X-API-Key",
                                        "value": "{{X-API-Key}}",
                                        "type": "text",
                                        "description": "Set when `data.authMethod` is `apikey`."
                                    },
                                    {
                                        "key": "User-Agent",
                                        "value": "{{User-Agent}}",
                                        "type": "text",
                                        "description": "Identifies the Sender service making the call."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.comhttps://your-server.example.com/your-webhook",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "comhttps"
                                    ],
                                    "path": [
                                        "your-server.example.com",
                                        "your-webhook"
                                    ]
                                },
                                "description": "**Reference only** — this page documents the request that **Sender sends** to the URL you registered\nin [Create external provider](/api-reference/sender/external-provider/setup/create). You do not call\nthis endpoint; you implement it.\n\n## Authentication\n\nThe `Authorization` (or `X-API-Key`) header is built from the `data.authMethod`/`data.authToken` you\nsaved on the provider:\n\n| `authMethod` | Header |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header is sent |\n\n## Expected response\n\n| HTTP status | Sender behaviour |\n| --- | --- |\n| `2xx` | Success — message marked as `done`. |\n| `4xx` | Permanent error — no retry. |\n| `5xx` | Transient error — retried. |\n| Timeout | Transient error — retried. |",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"event\": \"message.send\",\n    \"timestamp\": \"2026-02-26T14:30:00Z\",\n    \"organization\": \"xpto\",\n    \"message\": {\n        \"id\": \"12345\",\n        \"sequence\": \"welcome\",\n        \"slug\": \"welcome_email\",\n        \"subject\": \"Olá Joao, bem-vindo!\",\n        \"body\": \"Seu cadastro foi confirmado. Aproveite seu cashback de R$ 50,00.\",\n        \"destination\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"+5511999999999\",\n            \"countryCallingCode\": \"55\"\n        }\n    },\n    \"variables\": {\n        \"client\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"11999999999\"\n        },\n        \"order\": {\n            \"id\": 123,\n            \"total\": 5000,\n            \"date\": \"2026-02-26 14:30:00\"\n        },\n        \"reward\": {\n            \"name\": \"Cashback\",\n            \"value\": 5000\n        },\n        \"organization\": {\n            \"name\": \"Loja XYZ\",\n            \"currency\": \"BRL\",\n            \"language\": \"pt_BR\"\n        }\n    }\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Webhook accepted the message — Sender marks it as `done`.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json`."
                                            },
                                            {
                                                "key": "Authorization",
                                                "value": "{{Authorization}}",
                                                "type": "text",
                                                "description": "Set when `data.authMethod` is `bearer` or `basic`. See the table above."
                                            },
                                            {
                                                "key": "X-API-Key",
                                                "value": "{{X-API-Key}}",
                                                "type": "text",
                                                "description": "Set when `data.authMethod` is `apikey`."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Identifies the Sender service making the call."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.comhttps://your-server.example.com/your-webhook",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "comhttps"
                                            ],
                                            "path": [
                                                "your-server.example.com",
                                                "your-webhook"
                                            ]
                                        },
                                        "description": "**Reference only** — this page documents the request that **Sender sends** to the URL you registered\nin [Create external provider](/api-reference/sender/external-provider/setup/create). You do not call\nthis endpoint; you implement it.\n\n## Authentication\n\nThe `Authorization` (or `X-API-Key`) header is built from the `data.authMethod`/`data.authToken` you\nsaved on the provider:\n\n| `authMethod` | Header |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header is sent |\n\n## Expected response\n\n| HTTP status | Sender behaviour |\n| --- | --- |\n| `2xx` | Success — message marked as `done`. |\n| `4xx` | Permanent error — no retry. |\n| `5xx` | Transient error — retried. |\n| Timeout | Transient error — retried. |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"event\": \"message.send\",\n    \"timestamp\": \"2026-02-26T14:30:00Z\",\n    \"organization\": \"xpto\",\n    \"message\": {\n        \"id\": \"12345\",\n        \"sequence\": \"welcome\",\n        \"slug\": \"welcome_email\",\n        \"subject\": \"Olá Joao, bem-vindo!\",\n        \"body\": \"Seu cadastro foi confirmado. Aproveite seu cashback de R$ 50,00.\",\n        \"destination\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"+5511999999999\",\n            \"countryCallingCode\": \"55\"\n        }\n    },\n    \"variables\": {\n        \"client\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"11999999999\"\n        },\n        \"order\": {\n            \"id\": 123,\n            \"total\": 5000,\n            \"date\": \"2026-02-26 14:30:00\"\n        },\n        \"reward\": {\n            \"name\": \"Cashback\",\n            \"value\": 5000\n        },\n        \"organization\": {\n            \"name\": \"Loja XYZ\",\n            \"currency\": \"BRL\",\n            \"language\": \"pt_BR\"\n        }\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"received\": true }"
                                },
                                {
                                    "name": "Permanent client error — Sender will **not** retry.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json`."
                                            },
                                            {
                                                "key": "Authorization",
                                                "value": "{{Authorization}}",
                                                "type": "text",
                                                "description": "Set when `data.authMethod` is `bearer` or `basic`. See the table above."
                                            },
                                            {
                                                "key": "X-API-Key",
                                                "value": "{{X-API-Key}}",
                                                "type": "text",
                                                "description": "Set when `data.authMethod` is `apikey`."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Identifies the Sender service making the call."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.comhttps://your-server.example.com/your-webhook",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "comhttps"
                                            ],
                                            "path": [
                                                "your-server.example.com",
                                                "your-webhook"
                                            ]
                                        },
                                        "description": "**Reference only** — this page documents the request that **Sender sends** to the URL you registered\nin [Create external provider](/api-reference/sender/external-provider/setup/create). You do not call\nthis endpoint; you implement it.\n\n## Authentication\n\nThe `Authorization` (or `X-API-Key`) header is built from the `data.authMethod`/`data.authToken` you\nsaved on the provider:\n\n| `authMethod` | Header |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header is sent |\n\n## Expected response\n\n| HTTP status | Sender behaviour |\n| --- | --- |\n| `2xx` | Success — message marked as `done`. |\n| `4xx` | Permanent error — no retry. |\n| `5xx` | Transient error — retried. |\n| Timeout | Transient error — retried. |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"event\": \"message.send\",\n    \"timestamp\": \"2026-02-26T14:30:00Z\",\n    \"organization\": \"xpto\",\n    \"message\": {\n        \"id\": \"12345\",\n        \"sequence\": \"welcome\",\n        \"slug\": \"welcome_email\",\n        \"subject\": \"Olá Joao, bem-vindo!\",\n        \"body\": \"Seu cadastro foi confirmado. Aproveite seu cashback de R$ 50,00.\",\n        \"destination\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"+5511999999999\",\n            \"countryCallingCode\": \"55\"\n        }\n    },\n    \"variables\": {\n        \"client\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"11999999999\"\n        },\n        \"order\": {\n            \"id\": 123,\n            \"total\": 5000,\n            \"date\": \"2026-02-26 14:30:00\"\n        },\n        \"reward\": {\n            \"name\": \"Cashback\",\n            \"value\": 5000\n        },\n        \"organization\": {\n            \"name\": \"Loja XYZ\",\n            \"currency\": \"BRL\",\n            \"language\": \"pt_BR\"\n        }\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Invalid payload\" }"
                                },
                                {
                                    "name": "Server error — Sender will retry according to its backoff policy.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json`."
                                            },
                                            {
                                                "key": "Authorization",
                                                "value": "{{Authorization}}",
                                                "type": "text",
                                                "description": "Set when `data.authMethod` is `bearer` or `basic`. See the table above."
                                            },
                                            {
                                                "key": "X-API-Key",
                                                "value": "{{X-API-Key}}",
                                                "type": "text",
                                                "description": "Set when `data.authMethod` is `apikey`."
                                            },
                                            {
                                                "key": "User-Agent",
                                                "value": "{{User-Agent}}",
                                                "type": "text",
                                                "description": "Identifies the Sender service making the call."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.comhttps://your-server.example.com/your-webhook",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "comhttps"
                                            ],
                                            "path": [
                                                "your-server.example.com",
                                                "your-webhook"
                                            ]
                                        },
                                        "description": "**Reference only** — this page documents the request that **Sender sends** to the URL you registered\nin [Create external provider](/api-reference/sender/external-provider/setup/create). You do not call\nthis endpoint; you implement it.\n\n## Authentication\n\nThe `Authorization` (or `X-API-Key`) header is built from the `data.authMethod`/`data.authToken` you\nsaved on the provider:\n\n| `authMethod` | Header |\n| --- | --- |\n| `bearer` | `Authorization: Bearer {authToken}` |\n| `basic`  | `Authorization: Basic base64(authUsername:authPassword)` |\n| `apikey` | `X-API-Key: {authToken}` |\n| `none`   | No auth header is sent |\n\n## Expected response\n\n| HTTP status | Sender behaviour |\n| --- | --- |\n| `2xx` | Success — message marked as `done`. |\n| `4xx` | Permanent error — no retry. |\n| `5xx` | Transient error — retried. |\n| Timeout | Transient error — retried. |",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"event\": \"message.send\",\n    \"timestamp\": \"2026-02-26T14:30:00Z\",\n    \"organization\": \"xpto\",\n    \"message\": {\n        \"id\": \"12345\",\n        \"sequence\": \"welcome\",\n        \"slug\": \"welcome_email\",\n        \"subject\": \"Olá Joao, bem-vindo!\",\n        \"body\": \"Seu cadastro foi confirmado. Aproveite seu cashback de R$ 50,00.\",\n        \"destination\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"+5511999999999\",\n            \"countryCallingCode\": \"55\"\n        }\n    },\n    \"variables\": {\n        \"client\": {\n            \"name\": \"Joao Silva\",\n            \"email\": \"joao@email.com\",\n            \"cellphone\": \"11999999999\"\n        },\n        \"order\": {\n            \"id\": 123,\n            \"total\": 5000,\n            \"date\": \"2026-02-26 14:30:00\"\n        },\n        \"reward\": {\n            \"name\": \"Cashback\",\n            \"value\": 5000\n        },\n        \"organization\": {\n            \"name\": \"Loja XYZ\",\n            \"currency\": \"BRL\",\n            \"language\": \"pt_BR\"\n        }\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Internal Server Error",
                                    "code": 500,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": \"Internal server error\" }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Message type",
                    "item": [
                        {
                            "name": "Message type: Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/message-type/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "message-type",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single message type by id, including its declared variables and the mockup payload."
                            },
                            "response": [
                                {
                                    "name": "Message type with `variables` and `mockupData`",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/message-type/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "message-type",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single message type by id, including its declared variables and the mockup payload."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/message-type/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "message-type",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single message type by id, including its declared variables and the mockup payload."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Message type: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/message-type",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "message-type"
                                    ]
                                },
                                "description": "Lists every message type registered in the platform. A *message type*\nis a transactional event slug (e.g. `welcome`, `order.confirmed`,\n`password.reset`) plus its declared variables and a mockup payload.\nThe admin uses this to render the variable picker when authoring a\ntemplate."
                            },
                            "response": [
                                {
                                    "name": "List of message types",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/message-type",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "message-type"
                                            ]
                                        },
                                        "description": "Lists every message type registered in the platform. A *message type*\nis a transactional event slug (e.g. `welcome`, `order.confirmed`,\n`password.reset`) plus its declared variables and a mockup payload.\nThe admin uses this to render the variable picker when authoring a\ntemplate."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        { \"id\": 1, \"slug\": \"order.confirmed\", \"name\": \"Order confirmed\", \"description\": \"Sent after every paid order.\" }\n    ]\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Messages",
                    "item": [
                        {
                            "name": "Messages: Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "messages",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns the full message-process-queue entry plus all dispatchers it spawned."
                            },
                            "response": [
                                {
                                    "name": "Message with dispatchers",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns the full message-process-queue entry plus all dispatchers it spawned."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns the full message-process-queue entry plus all dispatchers it spawned."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Messages: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/messages",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "messages"
                                    ]
                                },
                                "description": "Paginated view of `message_process_queue` (admin mode excluded)\nwith a per-row dispatcher summary. Drives the message log screen\nin the admin.\n\nTo find which message started a conversation from a phone number,\nfilter by `cellphone` (exact) and ask for the body with\n`include=rendered_body` — one call returns the recent messages to\nthat number with the rendered text, no detail round-trip and no\ncustomer lookup needed."
                            },
                            "response": [
                                {
                                    "name": "Paginated list",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages"
                                            ]
                                        },
                                        "description": "Paginated view of `message_process_queue` (admin mode excluded)\nwith a per-row dispatcher summary. Drives the message log screen\nin the admin.\n\nTo find which message started a conversation from a phone number,\nfilter by `cellphone` (exact) and ask for the body with\n`include=rendered_body` — one call returns the recent messages to\nthat number with the rendered text, no detail round-trip and no\ncustomer lookup needed."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Messages: Metrics (raw, by sequence)",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/messages/metrics/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "messages",
                                        "metrics",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Raw delivery_status counts for a sequence, nested by\n`[slug][providerType][delivery_status]`. The `{id}` is the numeric\n**sequence** id (not a message id).\n\nPrefer **Delivery & Open Rate by Campaign**\n(`/api/sender/report/sequence-delivery/{sequence}`): it accepts the campaign\n`messageSequence` slug, rolls the counts up per channel and returns the\ndelivery and open rates. This raw endpoint stays for the panel."
                            },
                            "response": [
                                {
                                    "name": "Metrics roll-up",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages/metrics/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages",
                                                "metrics",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Raw delivery_status counts for a sequence, nested by\n`[slug][providerType][delivery_status]`. The `{id}` is the numeric\n**sequence** id (not a message id).\n\nPrefer **Delivery & Open Rate by Campaign**\n(`/api/sender/report/sequence-delivery/{sequence}`): it accepts the campaign\n`messageSequence` slug, rolls the counts up per channel and returns the\ndelivery and open rates. This raw endpoint stays for the panel."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Messages: Resend — Private",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}/resend",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "messages",
                                        "{{id}}",
                                        "resend"
                                    ]
                                },
                                "description": "Resends selected dispatchers from an existing message process.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"dispatchers\": \"[101, 102]\",\n    \"resentBy\": \"42\",\n    \"recipient\": {\n        \"id\": \"12345\",\n        \"name\": \"John Doe\",\n        \"email\": \"john@example.com\",\n        \"cellphone\": \"19981127262\",\n        \"countryCallingCode\": \"55\"\n    }\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}/resend",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages",
                                                "{{id}}",
                                                "resend"
                                            ]
                                        },
                                        "description": "Resends selected dispatchers from an existing message process.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"dispatchers\": \"[101, 102]\",\n    \"resentBy\": \"42\",\n    \"recipient\": {\n        \"id\": \"12345\",\n        \"name\": \"John Doe\",\n        \"email\": \"john@example.com\",\n        \"cellphone\": \"19981127262\",\n        \"countryCallingCode\": \"55\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"resent\": true,\n    \"processId\": 4986575,\n    \"dispatchers\": 1\n}"
                                },
                                {
                                    "name": "No dispatchers selected",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}/resend",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages",
                                                "{{id}}",
                                                "resend"
                                            ]
                                        },
                                        "description": "Resends selected dispatchers from an existing message process.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"dispatchers\": \"[101, 102]\",\n    \"resentBy\": \"42\",\n    \"recipient\": {\n        \"id\": \"12345\",\n        \"name\": \"John Doe\",\n        \"email\": \"john@example.com\",\n        \"cellphone\": \"19981127262\",\n        \"countryCallingCode\": \"55\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"No dispatchers selected\"\n}"
                                },
                                {
                                    "name": "Process not found",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/messages/{{id}}/resend",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "messages",
                                                "{{id}}",
                                                "resend"
                                            ]
                                        },
                                        "description": "Resends selected dispatchers from an existing message process.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"dispatchers\": \"[101, 102]\",\n    \"resentBy\": \"42\",\n    \"recipient\": {\n        \"id\": \"12345\",\n        \"name\": \"John Doe\",\n        \"email\": \"john@example.com\",\n        \"cellphone\": \"19981127262\",\n        \"countryCallingCode\": \"55\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"error\": \"Process not found\"\n}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Opt-out",
                    "item": [
                        {
                            "name": "Opt-out: Count",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/count",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "opt-preference",
                                        "count"
                                    ]
                                },
                                "description": "How many opt-out records match the filters. Same filters as\n[List](/docs/{lang}/api-reference/sender/opt-preference/list), without pagination.\n\nCounts **rows, not people**: a customer registered with person + e-mail + phone counts as\nthree. Filter by `target_type=person` for a closer proxy of distinct customers."
                            },
                            "response": [
                                {
                                    "name": "Total",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/count",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference",
                                                "count"
                                            ]
                                        },
                                        "description": "How many opt-out records match the filters. Same filters as\n[List](/docs/{lang}/api-reference/sender/opt-preference/list), without pagination.\n\nCounts **rows, not people**: a customer registered with person + e-mail + phone counts as\nthree. Filter by `target_type=person` for a closer proxy of distinct customers."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"total\": 128 }"
                                }
                            ]
                        },
                        {
                            "name": "Opt-out: Register",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "opt-preference"
                                    ]
                                },
                                "description": "Registers that a customer no longer wants to receive communication. Blocks every\nmessage except the login PIN.\n\nSend **all the identifiers you have** — `person`, `email` and `cellphone`. One row is\nstored per identifier and delivery is blocked when **any** of them matches. That is what\nmakes the opt-out survive a re-registration: if the customer signs up again and gets a new\n`person` id, the e-mail and phone still match. The reverse also holds — if they change\ne-mail inside the same record, the `person` target still matches.\n\nThe opt-out is scoped to the organization in the subdomain: the same e-mail can be blocked\nin one organization and keep receiving in another. It never applies across organizations.\n\nIdempotent: registering the same identifier again updates the row instead of duplicating\nit, and appends an entry to the audit trail either way.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"person\": 184532,\n    \"email\": \"cliente@exemplo.com\",\n    \"cellphone\": \"5512345678\",\n    \"countryCallingCode\": \"52\",\n    \"provider\": \"<provider>\",\n    \"scope\": \"<scope>\",\n    \"source\": \"<source>\",\n    \"actor\": \"maria@lojista.com\",\n    \"detail\": \"pediu por telefone no SAC\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Registered — one target per identifier sent",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference"
                                            ]
                                        },
                                        "description": "Registers that a customer no longer wants to receive communication. Blocks every\nmessage except the login PIN.\n\nSend **all the identifiers you have** — `person`, `email` and `cellphone`. One row is\nstored per identifier and delivery is blocked when **any** of them matches. That is what\nmakes the opt-out survive a re-registration: if the customer signs up again and gets a new\n`person` id, the e-mail and phone still match. The reverse also holds — if they change\ne-mail inside the same record, the `person` target still matches.\n\nThe opt-out is scoped to the organization in the subdomain: the same e-mail can be blocked\nin one organization and keep receiving in another. It never applies across organizations.\n\nIdempotent: registering the same identifier again updates the row instead of duplicating\nit, and appends an entry to the audit trail either way.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 184532,\n    \"email\": \"cliente@exemplo.com\",\n    \"cellphone\": \"5512345678\",\n    \"countryCallingCode\": \"52\",\n    \"provider\": \"<provider>\",\n    \"scope\": \"<scope>\",\n    \"source\": \"<source>\",\n    \"actor\": \"maria@lojista.com\",\n    \"detail\": \"pediu por telefone no SAC\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"type\": \"optout\",\n  \"provider\": \"all\",\n  \"scope\": \"all\",\n  \"targets\": [\n    { \"target_type\": \"person\", \"target\": \"184532\" },\n    { \"target_type\": \"email\",  \"target\": \"cliente@exemplo.com\" },\n    { \"target_type\": \"phone\",  \"target\": \"525512345678\" }\n  ]\n}"
                                },
                                {
                                    "name": "No identifier, phone without country code, or invalid provider/scope/source",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference"
                                            ]
                                        },
                                        "description": "Registers that a customer no longer wants to receive communication. Blocks every\nmessage except the login PIN.\n\nSend **all the identifiers you have** — `person`, `email` and `cellphone`. One row is\nstored per identifier and delivery is blocked when **any** of them matches. That is what\nmakes the opt-out survive a re-registration: if the customer signs up again and gets a new\n`person` id, the e-mail and phone still match. The reverse also holds — if they change\ne-mail inside the same record, the `person` target still matches.\n\nThe opt-out is scoped to the organization in the subdomain: the same e-mail can be blocked\nin one organization and keep receiving in another. It never applies across organizations.\n\nIdempotent: registering the same identifier again updates the row instead of duplicating\nit, and appends an entry to the audit trail either way.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 184532,\n    \"email\": \"cliente@exemplo.com\",\n    \"cellphone\": \"5512345678\",\n    \"countryCallingCode\": \"52\",\n    \"provider\": \"<provider>\",\n    \"scope\": \"<scope>\",\n    \"source\": \"<source>\",\n    \"actor\": \"maria@lojista.com\",\n    \"detail\": \"pediu por telefone no SAC\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Unprocessable Entity",
                                    "code": 422,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": true, \"message\": \"countryCallingCode e obrigatorio junto com cellphone\" }"
                                }
                            ]
                        },
                        {
                            "name": "Opt-out: Revoke",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "opt-preference"
                                    ]
                                },
                                "description": "Puts a customer back on the list — they start receiving again.\n\nRevokes **only the identifiers you send**. If the opt-out was registered with e-mail and\nphone and you send just the e-mail, the phone stays blocked. That is deliberate: partial\nrevocation should never be a side effect.\n\nThe current state is deleted, but the audit trail is not. The revocation is appended to it,\nso the history of what the customer asked for is never lost.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"person\": 184532,\n    \"email\": \"cliente@exemplo.com\",\n    \"cellphone\": \"5512345678\",\n    \"countryCallingCode\": \"52\",\n    \"provider\": \"<provider>\",\n    \"scope\": \"<scope>\",\n    \"source\": \"<source>\",\n    \"actor\": \"<actor>\",\n    \"detail\": \"<detail>\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Revoked. `removed` is how many state rows were actually deleted — `0` means there was no opt-out for those targets.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference"
                                            ]
                                        },
                                        "description": "Puts a customer back on the list — they start receiving again.\n\nRevokes **only the identifiers you send**. If the opt-out was registered with e-mail and\nphone and you send just the e-mail, the phone stays blocked. That is deliberate: partial\nrevocation should never be a side effect.\n\nThe current state is deleted, but the audit trail is not. The revocation is appended to it,\nso the history of what the customer asked for is never lost.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 184532,\n    \"email\": \"cliente@exemplo.com\",\n    \"cellphone\": \"5512345678\",\n    \"countryCallingCode\": \"52\",\n    \"provider\": \"<provider>\",\n    \"scope\": \"<scope>\",\n    \"source\": \"<source>\",\n    \"actor\": \"<actor>\",\n    \"detail\": \"<detail>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"type\": \"optin\",\n  \"targets\": [\n    { \"target_type\": \"person\", \"target\": \"184532\" },\n    { \"target_type\": \"email\",  \"target\": \"cliente@exemplo.com\" }\n  ],\n  \"removed\": 2\n}"
                                },
                                {
                                    "name": "No identifier, phone without country code, or invalid provider/scope/source",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference"
                                            ]
                                        },
                                        "description": "Puts a customer back on the list — they start receiving again.\n\nRevokes **only the identifiers you send**. If the opt-out was registered with e-mail and\nphone and you send just the e-mail, the phone stays blocked. That is deliberate: partial\nrevocation should never be a side effect.\n\nThe current state is deleted, but the audit trail is not. The revocation is appended to it,\nso the history of what the customer asked for is never lost.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 184532,\n    \"email\": \"cliente@exemplo.com\",\n    \"cellphone\": \"5512345678\",\n    \"countryCallingCode\": \"52\",\n    \"provider\": \"<provider>\",\n    \"scope\": \"<scope>\",\n    \"source\": \"<source>\",\n    \"actor\": \"<actor>\",\n    \"detail\": \"<detail>\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Unprocessable Entity",
                                    "code": 422,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Opt-out: History",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/history",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "opt-preference",
                                        "history"
                                    ]
                                },
                                "description": "Append-only trail of everything ever registered or revoked for a customer, newest first.\n\nSeparate from the current state on purpose: the state row is overwritten on every change,\nwhile this is never rewritten or deleted. It is what proves *who* asked to stop, *when* and\n*through which channel* — including opt-outs that were later revoked and no longer appear\nin [Check](/docs/{lang}/api-reference/sender/opt-preference/lookup)."
                            },
                            "response": [
                                {
                                    "name": "Trail, newest first",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/history",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference",
                                                "history"
                                            ]
                                        },
                                        "description": "Append-only trail of everything ever registered or revoked for a customer, newest first.\n\nSeparate from the current state on purpose: the state row is overwritten on every change,\nwhile this is never rewritten or deleted. It is what proves *who* asked to stop, *when* and\n*through which channel* — including opt-outs that were later revoked and no longer appear\nin [Check](/docs/{lang}/api-reference/sender/opt-preference/lookup)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"targets\": [\n    { \"target_type\": \"email\", \"target\": \"cliente@exemplo.com\" }\n  ],\n  \"history\": [\n    {\n      \"target_type\": \"email\", \"target\": \"cliente@exemplo.com\",\n      \"provider\": \"all\", \"scope\": \"all\", \"type\": \"optin\",\n      \"source\": \"admin\", \"actor\": \"maria@lojista.com\", \"person\": 184532,\n      \"detail\": \"voltou atras\", \"createdAt\": \"2026-09-02 15:40:11\"\n    },\n    {\n      \"target_type\": \"email\", \"target\": \"cliente@exemplo.com\",\n      \"provider\": \"all\", \"scope\": \"all\", \"type\": \"optout\",\n      \"source\": \"admin\", \"actor\": \"maria@lojista.com\", \"person\": 184532,\n      \"detail\": \"pediu por telefone no SAC\", \"createdAt\": \"2026-09-02 10:14:03\"\n    }\n  ]\n}"
                                },
                                {
                                    "name": "No identifier provided",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/history",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference",
                                                "history"
                                            ]
                                        },
                                        "description": "Append-only trail of everything ever registered or revoked for a customer, newest first.\n\nSeparate from the current state on purpose: the state row is overwritten on every change,\nwhile this is never rewritten or deleted. It is what proves *who* asked to stop, *when* and\n*through which channel* — including opt-outs that were later revoked and no longer appear\nin [Check](/docs/{lang}/api-reference/sender/opt-preference/lookup)."
                                    },
                                    "status": "Unprocessable Entity",
                                    "code": 422,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Opt-out: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "opt-preference"
                                    ]
                                },
                                "description": "Paginated list of the opt-out records of the organization, newest first.\n\nOne row per identifier, so a customer registered with person + e-mail + phone appears as\nthree rows. To ask about one specific customer, use\n[Check](/docs/{lang}/api-reference/sender/opt-preference/lookup) instead."
                            },
                            "response": [
                                {
                                    "name": "List of records",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference"
                                            ]
                                        },
                                        "description": "Paginated list of the opt-out records of the organization, newest first.\n\nOne row per identifier, so a customer registered with person + e-mail + phone appears as\nthree rows. To ask about one specific customer, use\n[Check](/docs/{lang}/api-reference/sender/opt-preference/lookup) instead."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "[\n  {\n    \"id\": 41,\n    \"organization\": \"acme\",\n    \"target_type\": \"email\",\n    \"target\": \"cliente@exemplo.com\",\n    \"provider\": \"all\",\n    \"scope\": \"all\",\n    \"type\": \"optout\",\n    \"source\": \"admin\",\n    \"actor\": \"maria@lojista.com\",\n    \"detail\": \"pediu por telefone no SAC\",\n    \"person\": 184532,\n    \"createdAt\": \"2026-09-02 10:14:03\",\n    \"updatedAt\": \"2026-09-02 10:14:03\"\n  }\n]"
                                }
                            ]
                        },
                        {
                            "name": "Opt-out: Check",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/lookup",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "opt-preference",
                                        "lookup"
                                    ]
                                },
                                "description": "Answers the question support actually asks: **would a message to this customer be\nblocked?**\n\nPass any combination of identifiers. The check uses the same matching the delivery path\nuses, so `optedOut` is what will really happen — not an approximation. `matchedBy` says\n*which* identifier caused it, which matters: blocked by e-mail and blocked by person lead\nto different conversations.\n\nScoped to the organization in the subdomain."
                            },
                            "response": [
                                {
                                    "name": "Current state. `optedOut` is the verdict; `preferences` lists every stored row for those identifiers.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/lookup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference",
                                                "lookup"
                                            ]
                                        },
                                        "description": "Answers the question support actually asks: **would a message to this customer be\nblocked?**\n\nPass any combination of identifiers. The check uses the same matching the delivery path\nuses, so `optedOut` is what will really happen — not an approximation. `matchedBy` says\n*which* identifier caused it, which matters: blocked by e-mail and blocked by person lead\nto different conversations.\n\nScoped to the organization in the subdomain."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n  \"targets\": [\n    { \"target_type\": \"person\", \"target\": \"184532\" },\n    { \"target_type\": \"email\",  \"target\": \"cliente@exemplo.com\" }\n  ],\n  \"optedOut\": true,\n  \"matchedBy\": {\n    \"target_type\": \"email\",\n    \"target\": \"cliente@exemplo.com\",\n    \"provider\": \"all\",\n    \"scope\": \"all\",\n    \"source\": \"admin\",\n    \"createdAt\": \"2026-09-02 10:14:03\"\n  },\n  \"preferences\": [\n    {\n      \"target_type\": \"email\", \"target\": \"cliente@exemplo.com\",\n      \"provider\": \"all\", \"scope\": \"all\", \"type\": \"optout\",\n      \"source\": \"admin\", \"actor\": \"maria@lojista.com\", \"person\": 184532,\n      \"detail\": \"pediu por telefone no SAC\",\n      \"createdAt\": \"2026-09-02 10:14:03\", \"updatedAt\": \"2026-09-02 10:14:03\"\n    }\n  ]\n}"
                                },
                                {
                                    "name": "No identifier provided",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/opt-preference/lookup",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "opt-preference",
                                                "lookup"
                                            ]
                                        },
                                        "description": "Answers the question support actually asks: **would a message to this customer be\nblocked?**\n\nPass any combination of identifiers. The check uses the same matching the delivery path\nuses, so `optedOut` is what will really happen — not an approximation. `matchedBy` says\n*which* identifier caused it, which matters: blocked by e-mail and blocked by person lead\nto different conversations.\n\nScoped to the organization in the subdomain."
                                    },
                                    "status": "Unprocessable Entity",
                                    "code": 422,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"error\": true, \"message\": \"Informe person, email ou cellphone\" }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Ping",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/sender/ping",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "sender",
                                "ping"
                            ]
                        },
                        "description": "Resource for checking service availability"
                    },
                    "response": [
                        {
                            "name": "Success",
                            "originalRequest": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/ping",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "ping"
                                    ]
                                },
                                "description": "Resource for checking service availability"
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": ""
                        }
                    ]
                },
                {
                    "name": "Provider type",
                    "item": [
                        {
                            "name": "Provider type: Create",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-type"
                                    ]
                                },
                                "description": "Registers a new provider type. Internal — usually shipped via migration.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"sms\",\n    \"name\": \"SMS\",\n    \"order\": 2\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-type"
                                            ]
                                        },
                                        "description": "Registers a new provider type. Internal — usually shipped via migration.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"sms\",\n    \"name\": \"SMS\",\n    \"order\": 2\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Provider type: Delete",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-type"
                                    ]
                                },
                                "description": "Removes a provider type. Provider Settings already linked to it become unusable.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 2\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-type"
                                            ]
                                        },
                                        "description": "Removes a provider type. Provider Settings already linked to it become unusable.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 2\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Provider type: Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-type/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-type",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single provider type by id."
                            },
                            "response": [
                                {
                                    "name": "Provider type",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-type/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-type",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single provider type by id."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 2, \"slug\": \"sms\", \"name\": \"SMS\", \"order\": 2 }"
                                },
                                {
                                    "name": "Not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-type/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-type",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single provider type by id."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Provider type: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-type"
                                    ]
                                },
                                "description": "Lists every provider type configured in the platform (`sms`, `email`, `whatsapp`, etc.). Drives the channel picker in the admin."
                            },
                            "response": [
                                {
                                    "name": "List of provider types",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-type"
                                            ]
                                        },
                                        "description": "Lists every provider type configured in the platform (`sms`, `email`, `whatsapp`, etc.). Drives the channel picker in the admin."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"list\": [\n        { \"id\": 1, \"slug\": \"email\",    \"name\": \"E-mail\",   \"order\": 1 },\n        { \"id\": 2, \"slug\": \"sms\",      \"name\": \"SMS\",      \"order\": 2 },\n        { \"id\": 3, \"slug\": \"whatsapp\", \"name\": \"WhatsApp\", \"order\": 3 }\n    ]\n}"
                                }
                            ]
                        },
                        {
                            "name": "Provider type: Update",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-type"
                                    ]
                                },
                                "description": "Updates an existing provider type's name or order.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 2,\n    \"slug\": \"sms\",\n    \"name\": \"SMS\",\n    \"order\": 2\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-type",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-type"
                                            ]
                                        },
                                        "description": "Updates an existing provider type's name or order.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 2,\n    \"slug\": \"sms\",\n    \"name\": \"SMS\",\n    \"order\": 2\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "ProviderSettings",
                    "item": [
                        {
                            "name": "Create Provider Setting",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-settings"
                                    ]
                                },
                                "description": "Stores the credentials/settings of a messaging provider (SMTP, Twilio SMS/WhatsApp, etc.) for the\norganization. The `provider` field is the numeric id of an entry in `provider_source` and the\n`data` block is provider-specific (see examples).\n\nFor webhook-based external providers use the dedicated\n[External provider · Create](/api-reference/sender/external-provider/setup/create) endpoint instead.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"provider\": 3,\n    \"data\": {\n        \"host\": \"smtp.example.com\",\n        \"port\": \"465\",\n        \"username\": \"sender@example.com\",\n        \"password\": \"********\",\n        \"encryption\": \"ssl\",\n        \"fromEmail\": \"no-reply@example.com\",\n        \"fromName\": \"Loja XYZ\"\n    }\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Provider setting created.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-settings"
                                            ]
                                        },
                                        "description": "Stores the credentials/settings of a messaging provider (SMTP, Twilio SMS/WhatsApp, etc.) for the\norganization. The `provider` field is the numeric id of an entry in `provider_source` and the\n`data` block is provider-specific (see examples).\n\nFor webhook-based external providers use the dedicated\n[External provider · Create](/api-reference/sender/external-provider/setup/create) endpoint instead.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"provider\": 3,\n    \"data\": {\n        \"host\": \"smtp.example.com\",\n        \"port\": \"465\",\n        \"username\": \"sender@example.com\",\n        \"password\": \"********\",\n        \"encryption\": \"ssl\",\n        \"fromEmail\": \"no-reply@example.com\",\n        \"fromName\": \"Loja XYZ\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 12,\n    \"provider\": 3,\n    \"data\": {\n        \"host\": \"smtp.example.com\",\n        \"port\": \"465\",\n        \"username\": \"sender@example.com\",\n        \"encryption\": \"ssl\",\n        \"fromEmail\": \"no-reply@example.com\",\n        \"fromName\": \"Loja XYZ\"\n    }\n}"
                                }
                            ]
                        },
                        {
                            "name": "Delete Provider Setting",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-settings"
                                    ]
                                },
                                "description": "Removes a provider settings entry from the organization. Templates that pointed to this entry will\nfall back to the default of the corresponding provider type — if no default exists, the dispatcher\nwill fail to send.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{ \"id\": 12 }",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Provider setting deleted.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-settings"
                                            ]
                                        },
                                        "description": "Removes a provider settings entry from the organization. Templates that pointed to this entry will\nfall back to the default of the corresponding provider type — if no default exists, the dispatcher\nwill fail to send.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{ \"id\": 12 }",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 12, \"deleted\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-settings",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single provider setting by ID."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-settings",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single provider setting by ID."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 3,\n    \"provider\": \"twilio\",\n    \"channels\": [\"sms\", \"whatsapp\"],\n    \"active\": true\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Provider Settings",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-settings"
                                    ]
                                },
                                "description": "Returns a paginated list of provider settings."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-settings"
                                            ]
                                        },
                                        "description": "Returns a paginated list of provider settings."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Update Provider Setting",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "provider-settings"
                                    ]
                                },
                                "description": "Updates an existing provider settings entry. The `id` is required; the remaining fields are\noptional and only the ones present in the body are written.\n\nWhen `default: true` is sent, every other entry of the same provider **type** in the organization\nis automatically un-defaulted, so there is at most one default per type.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 12,\n    \"default\": true,\n    \"data\": {\n        \"host\": \"smtp2.example.com\",\n        \"port\": \"587\",\n        \"username\": \"sender@example.com\",\n        \"password\": \"********\",\n        \"encryption\": \"tls\"\n    }\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Provider setting updated.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/provider-settings",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "provider-settings"
                                            ]
                                        },
                                        "description": "Updates an existing provider settings entry. The `id` is required; the remaining fields are\noptional and only the ones present in the body are written.\n\nWhen `default: true` is sent, every other entry of the same provider **type** in the organization\nis automatically un-defaulted, so there is at most one default per type.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 12,\n    \"default\": true,\n    \"data\": {\n        \"host\": \"smtp2.example.com\",\n        \"port\": \"587\",\n        \"username\": \"sender@example.com\",\n        \"password\": \"********\",\n        \"encryption\": \"tls\"\n    }\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 12, \"updated\": true }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Pulse",
                    "item": [
                        {
                            "name": "Pulse: Sample",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/pulse/sample",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "pulse",
                                        "sample"
                                    ]
                                },
                                "description": "Returns per-minute counts of `message.sent` and `message.failed`\ngrouped by organization, sampled from `message_dispatcher_queue`.\nInternal observability endpoint consumed by the Guper Dashboards\nservice.\n\nAuth: origin signature only."
                            },
                            "response": [
                                {
                                    "name": "Counts",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/pulse/sample",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "pulse",
                                                "sample"
                                            ]
                                        },
                                        "description": "Returns per-minute counts of `message.sent` and `message.failed`\ngrouped by organization, sampled from `message_dispatcher_queue`.\nInternal observability endpoint consumed by the Guper Dashboards\nservice.\n\nAuth: origin signature only."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"service\": \"sender\",\n    \"minute\":  \"2026-05-08 11:59:00\",\n    \"metrics\": [\n        { \"metric\": \"message.sent\",   \"organization\": \"acme\", \"value\": 142 },\n        { \"metric\": \"message.failed\", \"organization\": \"acme\", \"value\": 3 }\n    ]\n}"
                                },
                                {
                                    "name": "invalid minute (use Y-m-d H:i)",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/pulse/sample",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "pulse",
                                                "sample"
                                            ]
                                        },
                                        "description": "Returns per-minute counts of `message.sent` and `message.failed`\ngrouped by organization, sampled from `message_dispatcher_queue`.\nInternal observability endpoint consumed by the Guper Dashboards\nservice.\n\nAuth: origin signature only."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Queue",
                    "item": [
                        {
                            "name": "Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/queue/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "queue",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single queue entry by ID — useful to inspect the status of an outgoing message."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/queue/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "queue",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single queue entry by ID — useful to inspect the status of an outgoing message."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 9876,\n    \"to\": \"+5519954264546\",\n    \"channel\": \"whatsapp\",\n    \"template\": \"order-confirmation\",\n    \"status\": \"sent\",\n    \"queuedAt\": \"2026-05-01T11:00:00-03:00\",\n    \"sentAt\": \"2026-05-01T11:00:03-03:00\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Send Queue",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/queue",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "queue"
                                    ]
                                },
                                "description": "Returns a paginated list of queue entries."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/queue",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "queue"
                                            ]
                                        },
                                        "description": "Returns a paginated list of queue entries."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Reports",
                    "item": [
                        {
                            "name": "Delivery & Open Rate by Period",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/report/delivery/{{start}}/{{end}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "report",
                                        "delivery",
                                        "{{start}}",
                                        "{{end}}"
                                    ]
                                },
                                "description": "Aggregated delivery and open/read stats over a **date window** — for the whole\norganization or for a list of campaigns. It is the period version of\n*Delivery & Open Rate by Campaign*: same numbers, same reading, but answering\n\"how did our messaging do in September\" instead of \"how did this campaign do\".\n\n`start` and `end` are `YYYY-MM-DD` and **both inclusive**. The window runs on\n`insertedAt` — when the message entered the queue, which is what ties it to the\ncampaign that fired it, not when the provider answered.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `queued`, `unconfirmed`, `attempted`, `sent`, plus `deliveryRate`\n(delivered / attempted) and `openRate` (opened / delivered).\n\nTwo things worth knowing before you read the rates:\n\n- **`delivered` already includes what was opened.** `delivery_status` keeps the\n  most advanced state reached, so the counts are disjoint: a message that was\n  read is in `read`, not in `delivered`. This endpoint rolls it up for you —\n  `delivered` here means delivered *or better*. Adding up the raw statuses\n  yourself halves the rate.\n- **A provider that never confirms delivery stops at `sent`.** That is not\n  \"undelivered\", it is delivery without confirmation, so it goes to\n  `unconfirmed` and stays **out of `attempted` and out of both rates**. Today\n  only WhatsApp and email confirm delivery by webhook. `sent` is the grand\n  total that left the queue: `attempted + unconfirmed`.\n\nWith `groupBy=sequence` you also get `bySequence`, one row per campaign sorted\nby volume, each with the same totals plus its own `byChannel`. Messages sent\noutside a campaign (direct/hub dispatches) come back as a row with\n`sequence: null`.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/report/delivery/{{start}}/{{end}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "report",
                                                "delivery",
                                                "{{start}}",
                                                "{{end}}"
                                            ]
                                        },
                                        "description": "Aggregated delivery and open/read stats over a **date window** — for the whole\norganization or for a list of campaigns. It is the period version of\n*Delivery & Open Rate by Campaign*: same numbers, same reading, but answering\n\"how did our messaging do in September\" instead of \"how did this campaign do\".\n\n`start` and `end` are `YYYY-MM-DD` and **both inclusive**. The window runs on\n`insertedAt` — when the message entered the queue, which is what ties it to the\ncampaign that fired it, not when the provider answered.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `queued`, `unconfirmed`, `attempted`, `sent`, plus `deliveryRate`\n(delivered / attempted) and `openRate` (opened / delivered).\n\nTwo things worth knowing before you read the rates:\n\n- **`delivered` already includes what was opened.** `delivery_status` keeps the\n  most advanced state reached, so the counts are disjoint: a message that was\n  read is in `read`, not in `delivered`. This endpoint rolls it up for you —\n  `delivered` here means delivered *or better*. Adding up the raw statuses\n  yourself halves the rate.\n- **A provider that never confirms delivery stops at `sent`.** That is not\n  \"undelivered\", it is delivery without confirmation, so it goes to\n  `unconfirmed` and stays **out of `attempted` and out of both rates**. Today\n  only WhatsApp and email confirm delivery by webhook. `sent` is the grand\n  total that left the queue: `attempted + unconfirmed`.\n\nWith `groupBy=sequence` you also get `bySequence`, one row per campaign sorted\nby volume, each with the same totals plus its own `byChannel`. Messages sent\noutside a campaign (direct/hub dispatches) come back as a row with\n`sequence: null`.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Malformed dates, `end` before `start`, window over 366 days, or invalid `tz`.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/report/delivery/{{start}}/{{end}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "report",
                                                "delivery",
                                                "{{start}}",
                                                "{{end}}"
                                            ]
                                        },
                                        "description": "Aggregated delivery and open/read stats over a **date window** — for the whole\norganization or for a list of campaigns. It is the period version of\n*Delivery & Open Rate by Campaign*: same numbers, same reading, but answering\n\"how did our messaging do in September\" instead of \"how did this campaign do\".\n\n`start` and `end` are `YYYY-MM-DD` and **both inclusive**. The window runs on\n`insertedAt` — when the message entered the queue, which is what ties it to the\ncampaign that fired it, not when the provider answered.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `queued`, `unconfirmed`, `attempted`, `sent`, plus `deliveryRate`\n(delivered / attempted) and `openRate` (opened / delivered).\n\nTwo things worth knowing before you read the rates:\n\n- **`delivered` already includes what was opened.** `delivery_status` keeps the\n  most advanced state reached, so the counts are disjoint: a message that was\n  read is in `read`, not in `delivered`. This endpoint rolls it up for you —\n  `delivered` here means delivered *or better*. Adding up the raw statuses\n  yourself halves the rate.\n- **A provider that never confirms delivery stops at `sent`.** That is not\n  \"undelivered\", it is delivery without confirmation, so it goes to\n  `unconfirmed` and stays **out of `attempted` and out of both rates**. Today\n  only WhatsApp and email confirm delivery by webhook. `sent` is the grand\n  total that left the queue: `attempted + unconfirmed`.\n\nWith `groupBy=sequence` you also get `bySequence`, one row per campaign sorted\nby volume, each with the same totals plus its own `byChannel`. Messages sent\noutside a campaign (direct/hub dispatches) come back as a row with\n`sequence: null`.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here."
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "None of the sequences passed in `sequence` exist for this organization.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/report/delivery/{{start}}/{{end}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "report",
                                                "delivery",
                                                "{{start}}",
                                                "{{end}}"
                                            ]
                                        },
                                        "description": "Aggregated delivery and open/read stats over a **date window** — for the whole\norganization or for a list of campaigns. It is the period version of\n*Delivery & Open Rate by Campaign*: same numbers, same reading, but answering\n\"how did our messaging do in September\" instead of \"how did this campaign do\".\n\n`start` and `end` are `YYYY-MM-DD` and **both inclusive**. The window runs on\n`insertedAt` — when the message entered the queue, which is what ties it to the\ncampaign that fired it, not when the provider answered.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `queued`, `unconfirmed`, `attempted`, `sent`, plus `deliveryRate`\n(delivered / attempted) and `openRate` (opened / delivered).\n\nTwo things worth knowing before you read the rates:\n\n- **`delivered` already includes what was opened.** `delivery_status` keeps the\n  most advanced state reached, so the counts are disjoint: a message that was\n  read is in `read`, not in `delivered`. This endpoint rolls it up for you —\n  `delivered` here means delivered *or better*. Adding up the raw statuses\n  yourself halves the rate.\n- **A provider that never confirms delivery stops at `sent`.** That is not\n  \"undelivered\", it is delivery without confirmation, so it goes to\n  `unconfirmed` and stays **out of `attempted` and out of both rates**. Today\n  only WhatsApp and email confirm delivery by webhook. `sent` is the grand\n  total that left the queue: `attempted + unconfirmed`.\n\nWith `groupBy=sequence` you also get `bySequence`, one row per campaign sorted\nby volume, each with the same totals plus its own `byChannel`. Messages sent\noutside a campaign (direct/hub dispatches) come back as a row with\n`sequence: null`.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Delivery & Open Rate by Campaign",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/report/sequence-delivery/{{sequence}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "report",
                                        "sequence-delivery",
                                        "{{sequence}}"
                                    ]
                                },
                                "description": "Aggregated delivery and open/read stats for one message sequence — the answer\nto \"what was the open rate of this campaign\", \"how many were delivered vs\nfailed\", per channel and total.\n\nKey it by the **`messageSequence`** a loyalty campaign carries (the slug, e.g.\n`e4dc1e58-lojas-expirados-whats`) or the numeric sequence id. It resolves the\nslug for you.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `attempted`, plus `deliveryRate` (delivered / attempted) and\n`openRate` (opened / delivered). `opened` means the email was opened (Mailgun)\nor the WhatsApp was read.\n\nA provider that never confirms delivery stops at `sent`. That is not\n\"undelivered\", it is delivery without confirmation, so it goes to\n`unconfirmed` and stays out of `attempted` and out of both rates. Today only\nWhatsApp and email confirm delivery by webhook.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here — see the campaign's Audience Progress caveat."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/report/sequence-delivery/{{sequence}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "report",
                                                "sequence-delivery",
                                                "{{sequence}}"
                                            ]
                                        },
                                        "description": "Aggregated delivery and open/read stats for one message sequence — the answer\nto \"what was the open rate of this campaign\", \"how many were delivered vs\nfailed\", per channel and total.\n\nKey it by the **`messageSequence`** a loyalty campaign carries (the slug, e.g.\n`e4dc1e58-lojas-expirados-whats`) or the numeric sequence id. It resolves the\nslug for you.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `attempted`, plus `deliveryRate` (delivered / attempted) and\n`openRate` (opened / delivered). `opened` means the email was opened (Mailgun)\nor the WhatsApp was read.\n\nA provider that never confirms delivery stops at `sent`. That is not\n\"undelivered\", it is delivery without confirmation, so it goes to\n`unconfirmed` and stays out of `attempted` and out of both rates. Today only\nWhatsApp and email confirm delivery by webhook.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here — see the campaign's Audience Progress caveat."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Sequence not found for this organization.",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/report/sequence-delivery/{{sequence}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "report",
                                                "sequence-delivery",
                                                "{{sequence}}"
                                            ]
                                        },
                                        "description": "Aggregated delivery and open/read stats for one message sequence — the answer\nto \"what was the open rate of this campaign\", \"how many were delivered vs\nfailed\", per channel and total.\n\nKey it by the **`messageSequence`** a loyalty campaign carries (the slug, e.g.\n`e4dc1e58-lojas-expirados-whats`) or the numeric sequence id. It resolves the\nslug for you.\n\nPer channel and in total it returns `opened`, `delivered`, `accepted`,\n`failed`, `attempted`, plus `deliveryRate` (delivered / attempted) and\n`openRate` (opened / delivered). `opened` means the email was opened (Mailgun)\nor the WhatsApp was read.\n\nA provider that never confirms delivery stops at `sent`. That is not\n\"undelivered\", it is delivery without confirmation, so it goes to\n`unconfirmed` and stays out of `attempted` and out of both rates. Today only\nWhatsApp and email confirm delivery by webhook.\n\nNote: the count is **per sequence**. Two campaigns that share the same\n`messageSequence` add up here — see the campaign's Audience Progress caveat."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Sequence",
                    "item": [
                        {
                            "name": "Sequence: Create",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "sequence"
                                    ]
                                },
                                "description": "Creates a new sequence with a stable slug and a display name.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"welcome-flow\",\n    \"name\": \"Welcome flow\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence"
                                            ]
                                        },
                                        "description": "Creates a new sequence with a stable slug and a display name.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"welcome-flow\",\n    \"name\": \"Welcome flow\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Sequence: Delete",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "sequence"
                                    ]
                                },
                                "description": "Removes a sequence. Templates remain registered but lose this sequence binding.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 12\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence"
                                            ]
                                        },
                                        "description": "Removes a sequence. Templates remain registered but lose this sequence binding.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 12\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Sequence: Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "sequence",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single sequence by id."
                            },
                            "response": [
                                {
                                    "name": "Sequence",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single sequence by id."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single sequence by id."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Sequence: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "sequence"
                                    ]
                                },
                                "description": "Lists every message sequence registered by the organization. A\n*sequence* is a named collection of templates that fire together as a\ntransactional flow (e.g. `welcome-flow`, `cart-recovery`). Templates\nare attached to a sequence via the\n[Sequence templates](/docs/{lang}/api-reference/sender/sequence/templates/list)\nhub."
                            },
                            "response": [
                                {
                                    "name": "List of sequences",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence"
                                            ]
                                        },
                                        "description": "Lists every message sequence registered by the organization. A\n*sequence* is a named collection of templates that fire together as a\ntransactional flow (e.g. `welcome-flow`, `cart-recovery`). Templates\nare attached to a sequence via the\n[Sequence templates](/docs/{lang}/api-reference/sender/sequence/templates/list)\nhub."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"list\": [ { \"id\": 12, \"slug\": \"welcome-flow\", \"name\": \"Welcome flow\" } ] }"
                                }
                            ]
                        },
                        {
                            "name": "Sequence ↔ Template",
                            "item": [
                                {
                                    "name": "Sequence-Templates: Link",
                                    "request": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence",
                                                "{{id}}",
                                                "templates"
                                            ]
                                        },
                                        "description": "Links a template to a sequence. The server resolves the template's\n`trigger_slug` and `provider_type` automatically — the body only\ncarries the template id and the initial active flag.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"template\": 44,\n    \"active\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Linked",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "sequence",
                                                        "{{id}}",
                                                        "templates"
                                                    ]
                                                },
                                                "description": "Links a template to a sequence. The server resolves the template's\n`trigger_slug` and `provider_type` automatically — the body only\ncarries the template id and the initial active flag.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"template\": 44,\n    \"active\": true\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"sequence\": 12, \"template\": 44, \"active\": true }"
                                        },
                                        {
                                            "name": "Template not found",
                                            "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "sequence",
                                                        "{{id}}",
                                                        "templates"
                                                    ]
                                                },
                                                "description": "Links a template to a sequence. The server resolves the template's\n`trigger_slug` and `provider_type` automatically — the body only\ncarries the template id and the initial active flag.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"template\": 44,\n    \"active\": true\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "Not Found",
                                            "code": 404,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": ""
                                        }
                                    ]
                                },
                                {
                                    "name": "Sequence-Templates: List by sequence",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence",
                                                "{{id}}",
                                                "templates"
                                            ]
                                        },
                                        "description": "Returns the templates linked to a given sequence id."
                                    },
                                    "response": [
                                        {
                                            "name": "Templates linked to the sequence",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "sequence",
                                                        "{{id}}",
                                                        "templates"
                                                    ]
                                                },
                                                "description": "Returns the templates linked to a given sequence id."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        { \"sequence\": 12, \"template\": 44, \"trigger_slug\": \"order.confirmed\", \"provider_type\": 1, \"active\": 1 }\n    ]\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Sequence-Templates: List all",
                                    "request": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence-templates",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence-templates"
                                            ]
                                        },
                                        "description": "Lists every sequence↔template association registered by the\norganization. Supports the standard q/o/e/p list grammar; common\nfilter is `q[sequence][IN][]=...`."
                                    },
                                    "response": [
                                        {
                                            "name": "OK",
                                            "originalRequest": {
                                                "method": "GET",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence-templates",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "sequence-templates"
                                                    ]
                                                },
                                                "description": "Lists every sequence↔template association registered by the\norganization. Supports the standard q/o/e/p list grammar; common\nfilter is `q[sequence][IN][]=...`."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{\n    \"list\": [\n        { \"sequence\": 12, \"template\": 44, \"trigger_slug\": \"order.confirmed\", \"provider_type\": 1, \"active\": 1 }\n    ]\n}"
                                        }
                                    ]
                                },
                                {
                                    "name": "Sequence-Templates: Set active",
                                    "request": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates/{{templateId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence",
                                                "{{id}}",
                                                "templates",
                                                "{{templateId}}"
                                            ]
                                        },
                                        "description": "Toggles the active flag on a sequence↔template link without unlinking.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"active\": false\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "response": [
                                        {
                                            "name": "Updated",
                                            "originalRequest": {
                                                "method": "PUT",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates/{{templateId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "sequence",
                                                        "{{id}}",
                                                        "templates",
                                                        "{{templateId}}"
                                                    ]
                                                },
                                                "description": "Toggles the active flag on a sequence↔template link without unlinking.",
                                                "body": {
                                                    "mode": "raw",
                                                    "raw": "{\n    \"active\": false\n}",
                                                    "options": {
                                                        "raw": {
                                                            "language": "json"
                                                        }
                                                    }
                                                }
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"sequence\": 12, \"template\": 44, \"active\": false }"
                                        }
                                    ]
                                },
                                {
                                    "name": "Sequence-Templates: Unlink",
                                    "request": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates/{{templateId}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence",
                                                "{{id}}",
                                                "templates",
                                                "{{templateId}}"
                                            ]
                                        },
                                        "description": "Removes the sequence↔template association. Both rows remain registered; only the link row is deleted."
                                    },
                                    "response": [
                                        {
                                            "name": "Unlinked",
                                            "originalRequest": {
                                                "method": "DELETE",
                                                "header": [
                                                    {
                                                        "key": "x-guper-authorization",
                                                        "value": "{{x-guper-authorization}}",
                                                        "type": "text",
                                                        "description": "User token issued by Guper."
                                                    },
                                                    {
                                                        "key": "Content-Type",
                                                        "value": "{{Content-Type}}",
                                                        "type": "text",
                                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                                    }
                                                ],
                                                "url": {
                                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence/{{id}}/templates/{{templateId}}",
                                                    "protocol": "https",
                                                    "host": [
                                                        "{{organization}}",
                                                        "myguper",
                                                        "com"
                                                    ],
                                                    "path": [
                                                        "api",
                                                        "sender",
                                                        "sequence",
                                                        "{{id}}",
                                                        "templates",
                                                        "{{templateId}}"
                                                    ]
                                                },
                                                "description": "Removes the sequence↔template association. Both rows remain registered; only the link row is deleted."
                                            },
                                            "status": "OK",
                                            "code": 200,
                                            "_postman_previewlanguage": "json",
                                            "header": [
                                                {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                }
                                            ],
                                            "body": "{ \"sequence\": 12, \"template\": 44, \"unlinked\": true }"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "name": "Sequence: Update",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "sequence"
                                    ]
                                },
                                "description": "Updates a sequence's slug or display name.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 12,\n    \"slug\": \"welcome-flow\",\n    \"name\": \"Welcome flow\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/sequence",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "sequence"
                                            ]
                                        },
                                        "description": "Updates a sequence's slug or display name.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 12,\n    \"slug\": \"welcome-flow\",\n    \"name\": \"Welcome flow\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Template v2",
                    "item": [
                        {
                            "name": "Template v2: Create",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-v2"
                                    ]
                                },
                                "description": "Creates a new Communication Hub template. The body shape mirrors\n`Models\\\\Template::$visibleFields`. On save, the\n`ApplyOnSave` service can flip review state back to pending when\nrelevant fields change.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"provider\": 5,\n    \"name\": \"Order confirmed — pt-BR\",\n    \"key\": \"order-confirmed-ptbr\",\n    \"subject\": \"<subject>\",\n    \"body\": \"<body>\",\n    \"text\": \"<text>\",\n    \"extend\": \"<extend>\",\n    \"trigger_slug\": \"order.confirmed\",\n    \"language\": \"pt-BR\",\n    \"variables\": \"<variables>\",\n    \"meta\": \"<meta>\",\n    \"badges\": \"<badges>\",\n    \"tier\": 0,\n    \"is_active\": true\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Template created",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2"
                                            ]
                                        },
                                        "description": "Creates a new Communication Hub template. The body shape mirrors\n`Models\\\\Template::$visibleFields`. On save, the\n`ApplyOnSave` service can flip review state back to pending when\nrelevant fields change.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"provider\": 5,\n    \"name\": \"Order confirmed — pt-BR\",\n    \"key\": \"order-confirmed-ptbr\",\n    \"subject\": \"<subject>\",\n    \"body\": \"<body>\",\n    \"text\": \"<text>\",\n    \"extend\": \"<extend>\",\n    \"trigger_slug\": \"order.confirmed\",\n    \"language\": \"pt-BR\",\n    \"variables\": \"<variables>\",\n    \"meta\": \"<meta>\",\n    \"badges\": \"<badges>\",\n    \"tier\": 0,\n    \"is_active\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Missing required fields",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2"
                                            ]
                                        },
                                        "description": "Creates a new Communication Hub template. The body shape mirrors\n`Models\\\\Template::$visibleFields`. On save, the\n`ApplyOnSave` service can flip review state back to pending when\nrelevant fields change.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"provider\": 5,\n    \"name\": \"Order confirmed — pt-BR\",\n    \"key\": \"order-confirmed-ptbr\",\n    \"subject\": \"<subject>\",\n    \"body\": \"<body>\",\n    \"text\": \"<text>\",\n    \"extend\": \"<extend>\",\n    \"trigger_slug\": \"order.confirmed\",\n    \"language\": \"pt-BR\",\n    \"variables\": \"<variables>\",\n    \"meta\": \"<meta>\",\n    \"badges\": \"<badges>\",\n    \"tier\": 0,\n    \"is_active\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Template v2: Delete",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-v2"
                                    ]
                                },
                                "description": "Removes a Communication Hub template. Sequence links that referenced it become dangling — clean them via /sequence/{id}/templates/{templateId} first.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 44\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Deleted",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2"
                                            ]
                                        },
                                        "description": "Removes a Communication Hub template. Sequence links that referenced it become dangling — clean them via /sequence/{id}/templates/{templateId} first.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 44\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Template v2: Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-v2",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single template by id, with review state and provider settings binding."
                            },
                            "response": [
                                {
                                    "name": "Template",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single template by id, with review state and provider settings binding."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Not found",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single template by id, with review state and provider settings binding."
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Template v2: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-v2"
                                    ]
                                },
                                "description": "Lists every template registered through the Communication Hub\neditor (`template` table). Each row carries provider, channel\nmetadata, language, the rendered subject/body/text triplet, the\ndeclared `variables` and the review state (`review`, `reviewedAt`,\n`rejectionReason`)."
                            },
                            "response": [
                                {
                                    "name": "List of templates",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2"
                                            ]
                                        },
                                        "description": "Lists every template registered through the Communication Hub\neditor (`template` table). Each row carries provider, channel\nmetadata, language, the rendered subject/body/text triplet, the\ndeclared `variables` and the review state (`review`, `reviewedAt`,\n`rejectionReason`)."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Template v2: Send test",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}/send-test",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-v2",
                                        "{{id}}",
                                        "send-test"
                                    ]
                                },
                                "description": "Renders the template against the message type's mockup payload and\nsends it to the given `person` through the template's bound provider.\nUseful to validate end-to-end delivery before activating a template\nin production.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"person\": 47\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Test enqueued",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}/send-test",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2",
                                                "{{id}}",
                                                "send-test"
                                            ]
                                        },
                                        "description": "Renders the template against the message type's mockup payload and\nsends it to the given `person` through the template's bound provider.\nUseful to validate end-to-end delivery before activating a template\nin production.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 47\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"ok\": true }"
                                },
                                {
                                    "name": "Missing person",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}/send-test",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2",
                                                "{{id}}",
                                                "send-test"
                                            ]
                                        },
                                        "description": "Renders the template against the message type's mockup payload and\nsends it to the given `person` through the template's bound provider.\nUseful to validate end-to-end delivery before activating a template\nin production.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 47\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Bad Request",
                                    "code": 400,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                },
                                {
                                    "name": "Template / provider not found",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2/{{id}}/send-test",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2",
                                                "{{id}}",
                                                "send-test"
                                            ]
                                        },
                                        "description": "Renders the template against the message type's mockup payload and\nsends it to the given `person` through the template's bound provider.\nUseful to validate end-to-end delivery before activating a template\nin production.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"person\": 47\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "Not Found",
                                    "code": 404,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Template v2: Update",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-v2"
                                    ]
                                },
                                "description": "Updates an existing template. Same schema as create plus a required `id`.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 44,\n    \"provider\": 5,\n    \"name\": \"Order confirmed — pt-BR\",\n    \"key\": \"order-confirmed-ptbr\",\n    \"subject\": \"<subject>\",\n    \"body\": \"<body>\",\n    \"text\": \"<text>\",\n    \"extend\": \"<extend>\",\n    \"trigger_slug\": \"order.confirmed\",\n    \"language\": \"pt-BR\",\n    \"variables\": \"<variables>\",\n    \"meta\": \"<meta>\",\n    \"badges\": \"<badges>\",\n    \"tier\": 0,\n    \"is_active\": true\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Updated",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-v2",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-v2"
                                            ]
                                        },
                                        "description": "Updates an existing template. Same schema as create plus a required `id`.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 44,\n    \"provider\": 5,\n    \"name\": \"Order confirmed — pt-BR\",\n    \"key\": \"order-confirmed-ptbr\",\n    \"subject\": \"<subject>\",\n    \"body\": \"<body>\",\n    \"text\": \"<text>\",\n    \"extend\": \"<extend>\",\n    \"trigger_slug\": \"order.confirmed\",\n    \"language\": \"pt-BR\",\n    \"variables\": \"<variables>\",\n    \"meta\": \"<meta>\",\n    \"badges\": \"<badges>\",\n    \"tier\": 0,\n    \"is_active\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "TemplateOrganizationConfig",
                    "item": [
                        {
                            "name": "Create Template Org Config",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-organization-config"
                                    ]
                                },
                                "description": "Wires a template (`slug`) to a specific provider for the organization. When a template is rendered\nand no per-message provider is supplied, the dispatcher uses the entry registered here to decide\nwhich `provider_settings` row should send it.\n\nUse this endpoint when you want a template to use a non-default provider — otherwise the default of\nthe corresponding provider type is used automatically.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"welcome_email\",\n    \"type\": \"smtp\",\n    \"provider\": 12,\n    \"active\": true\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Mapping created.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-organization-config"
                                            ]
                                        },
                                        "description": "Wires a template (`slug`) to a specific provider for the organization. When a template is rendered\nand no per-message provider is supplied, the dispatcher uses the entry registered here to decide\nwhich `provider_settings` row should send it.\n\nUse this endpoint when you want a template to use a non-default provider — otherwise the default of\nthe corresponding provider type is used automatically.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"welcome_email\",\n    \"type\": \"smtp\",\n    \"provider\": 12,\n    \"active\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 5,\n    \"slug\": \"welcome_email\",\n    \"type\": \"smtp\",\n    \"provider\": 12,\n    \"active\": true\n}"
                                }
                            ]
                        },
                        {
                            "name": "Delete Template Org Config",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-organization-config"
                                    ]
                                },
                                "description": "Removes the template-to-provider mapping. After delete, the template falls back to the default\nprovider settings of its channel (`type`).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{ \"id\": 5 }",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Mapping removed.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-organization-config"
                                            ]
                                        },
                                        "description": "Removes the template-to-provider mapping. After delete, the template falls back to the default\nprovider settings of its channel (`type`).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{ \"id\": 5 }",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 5, \"deleted\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-organization-config",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single template-organization configuration by ID."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-organization-config",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single template-organization configuration by ID."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 1,\n    \"templateSlug\": \"order-confirmation\",\n    \"channels\": { \"whatsapp\": true, \"sms\": false, \"email\": true },\n    \"providerSettingId\": 3\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Template Org Configs",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-organization-config"
                                    ]
                                },
                                "description": "Returns a paginated list of template configs."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-organization-config"
                                            ]
                                        },
                                        "description": "Returns a paginated list of template configs."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Update Template Org Config",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-organization-config"
                                    ]
                                },
                                "description": "Updates an existing template-to-provider mapping. The `id` is required; remaining fields are\noptional and only the ones present in the body are written.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 5,\n    \"provider\": 14,\n    \"active\": true\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Mapping updated.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-organization-config",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-organization-config"
                                            ]
                                        },
                                        "description": "Updates an existing template-to-provider mapping. The `id` is required; remaining fields are\noptional and only the ones present in the body are written.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 5,\n    \"provider\": 14,\n    \"active\": true\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 5, \"updated\": true }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "TemplatesCustom",
                    "item": [
                        {
                            "name": "Create Custom Template",
                            "request": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-custom"
                                    ]
                                },
                                "description": "Stores an organization-specific override of a template. The base template (`slug`) is shared across\norganizations; this endpoint lets a single org provide its own subject/body for one of the supported\nchannels (`smtp`, `whatsapp`, `sms`).\n\nVariables follow the same Twig-style placeholders as the default templates (e.g. `{{ name }}`).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"slug\": \"welcome_email\",\n    \"type\": \"smtp\",\n    \"subject\": \"Bem-vindo, {{ name }}!\",\n    \"text\": \"Olá {{ name }}, seu cadastro foi confirmado.\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Custom template created.",
                                    "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-custom"
                                            ]
                                        },
                                        "description": "Stores an organization-specific override of a template. The base template (`slug`) is shared across\norganizations; this endpoint lets a single org provide its own subject/body for one of the supported\nchannels (`smtp`, `whatsapp`, `sms`).\n\nVariables follow the same Twig-style placeholders as the default templates (e.g. `{{ name }}`).",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"slug\": \"welcome_email\",\n    \"type\": \"smtp\",\n    \"subject\": \"Bem-vindo, {{ name }}!\",\n    \"text\": \"Olá {{ name }}, seu cadastro foi confirmado.\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 7,\n    \"slug\": \"welcome_email\",\n    \"type\": \"smtp\",\n    \"subject\": \"Bem-vindo, {{ name }}!\",\n    \"text\": \"Olá {{ name }}, seu cadastro foi confirmado.\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "Delete Custom Template",
                            "request": {
                                "method": "DELETE",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-custom"
                                    ]
                                },
                                "description": "Removes a custom template override. After delete, the organization falls back to the default\ntemplate registered globally for the same `slug` and channel.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{ \"id\": 7 }",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Custom template removed.",
                                    "originalRequest": {
                                        "method": "DELETE",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-custom"
                                            ]
                                        },
                                        "description": "Removes a custom template override. After delete, the organization falls back to the default\ntemplate registered globally for the same `slug` and channel.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{ \"id\": 7 }",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 7, \"deleted\": true }"
                                }
                            ]
                        },
                        {
                            "name": "Find",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-custom/{{id}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-custom",
                                        "{{id}}"
                                    ]
                                },
                                "description": "Returns a single custom message template by ID."
                            },
                            "response": [
                                {
                                    "name": "OK",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-custom/{{id}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-custom",
                                                "{{id}}"
                                            ]
                                        },
                                        "description": "Returns a single custom message template by ID."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{\n    \"id\": 12,\n    \"slug\": \"order-confirmation\",\n    \"channel\": \"whatsapp\",\n    \"language\": \"pt-BR\",\n    \"body\": \"Olá {{name}}! Seu pedido {{orderId}} foi confirmado.\"\n}"
                                }
                            ]
                        },
                        {
                            "name": "List Custom Templates",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": ""
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-custom"
                                    ]
                                },
                                "description": "Returns a paginated list of templates."
                            },
                            "response": [
                                {
                                    "name": "Success",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": ""
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-custom"
                                            ]
                                        },
                                        "description": "Returns a paginated list of templates."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Update Custom Template",
                            "request": {
                                "method": "PUT",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "template-custom"
                                    ]
                                },
                                "description": "Updates an existing custom template override. The `id` is required; remaining fields are optional\nand only the ones present in the body are written.",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"id\": 7,\n    \"subject\": \"Bem-vindo à Loja XYZ, {{ name }}!\",\n    \"text\": \"Olá {{ name }}, seu cadastro foi confirmado. Aproveite seu cashback de {{ reward.value }} centavos.\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "response": [
                                {
                                    "name": "Custom template updated.",
                                    "originalRequest": {
                                        "method": "PUT",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/template-custom",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "template-custom"
                                            ]
                                        },
                                        "description": "Updates an existing custom template override. The `id` is required; remaining fields are optional\nand only the ones present in the body are written.",
                                        "body": {
                                            "mode": "raw",
                                            "raw": "{\n    \"id\": 7,\n    \"subject\": \"Bem-vindo à Loja XYZ, {{ name }}!\",\n    \"text\": \"Olá {{ name }}, seu cadastro foi confirmado. Aproveite seu cashback de {{ reward.value }} centavos.\"\n}",
                                            "options": {
                                                "raw": {
                                                    "language": "json"
                                                }
                                            }
                                        }
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": "{ \"id\": 7, \"updated\": true }"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Variable set",
                    "item": [
                        {
                            "name": "Variable set: Find by trigger",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/variable-set/{{slug}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "variable-set",
                                        "{{slug}}"
                                    ]
                                },
                                "description": "Returns the variable set declared for a given trigger slug."
                            },
                            "response": [
                                {
                                    "name": "Variable set",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/variable-set/{{slug}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "variable-set",
                                                "{{slug}}"
                                            ]
                                        },
                                        "description": "Returns the variable set declared for a given trigger slug."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Variable set: List",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/variable-set",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "variable-set"
                                    ]
                                },
                                "description": "Lists every variable set declared by the platform. A *variable set*\nis the bag of variables a given trigger (`order.confirmed`,\n`welcome`, etc.) makes available to templates.\n\nFilter via `?category=campaign` to scope the list to a specific\ngrouping."
                            },
                            "response": [
                                {
                                    "name": "List of triggers and their variables",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/variable-set",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "variable-set"
                                            ]
                                        },
                                        "description": "Lists every variable set declared by the platform. A *variable set*\nis the bag of variables a given trigger (`order.confirmed`,\n`welcome`, etc.) makes available to templates.\n\nFilter via `?category=campaign` to scope the list to a specific\ngrouping."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        },
                        {
                            "name": "Variable set: List (expanded)",
                            "request": {
                                "method": "GET",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/variable-set/expand/{{expand}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "variable-set",
                                        "expand",
                                        "{{expand}}"
                                    ]
                                },
                                "description": "Same as List but with each variable inlined — useful when the admin\nneeds to render the variable picker without a second round-trip."
                            },
                            "response": [
                                {
                                    "name": "Expanded list",
                                    "originalRequest": {
                                        "method": "GET",
                                        "header": [
                                            {
                                                "key": "x-guper-authorization",
                                                "value": "{{x-guper-authorization}}",
                                                "type": "text",
                                                "description": "User token issued by Guper."
                                            },
                                            {
                                                "key": "Content-Type",
                                                "value": "{{Content-Type}}",
                                                "type": "text",
                                                "description": "Always `application/json` for endpoints that accept a JSON body."
                                            }
                                        ],
                                        "url": {
                                            "raw": "https://{{organization}}.myguper.com/api/sender/variable-set/expand/{{expand}}",
                                            "protocol": "https",
                                            "host": [
                                                "{{organization}}",
                                                "myguper",
                                                "com"
                                            ],
                                            "path": [
                                                "api",
                                                "sender",
                                                "variable-set",
                                                "expand",
                                                "{{expand}}"
                                            ]
                                        },
                                        "description": "Same as List but with each variable inlined — useful when the admin\nneeds to render the variable picker without a second round-trip."
                                    },
                                    "status": "OK",
                                    "code": 200,
                                    "_postman_previewlanguage": "json",
                                    "header": [
                                        {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                        }
                                    ],
                                    "body": ""
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "Webhook (inbound from provider)",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/sender/webhook/{{token}}",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "sender",
                                "webhook",
                                "{{token}}"
                            ]
                        },
                        "description": "Inbound webhook endpoint that providers (Twilio, SendGrid,\nWhatsApp Business, etc.) post delivery/status callbacks to. The\n`token` in the URL is a Guper-issued JWT that carries\n`{ o: organization, d: dispatcher_id }` — it authenticates the\ncaller without an `x-guper-authorization` header (providers can't\nsign requests on our behalf).\n\nThe handler validates the JWT, checks that the organization in the\ntoken matches the subdomain, enqueues the raw payload in\n`webhook_queue` for asynchronous processing, and returns 200\nimmediately. Actual status-event handling happens out-of-band in a\nworker."
                    },
                    "response": [
                        {
                            "name": "Enqueued",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/webhook/{{token}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "webhook",
                                        "{{token}}"
                                    ]
                                },
                                "description": "Inbound webhook endpoint that providers (Twilio, SendGrid,\nWhatsApp Business, etc.) post delivery/status callbacks to. The\n`token` in the URL is a Guper-issued JWT that carries\n`{ o: organization, d: dispatcher_id }` — it authenticates the\ncaller without an `x-guper-authorization` header (providers can't\nsign requests on our behalf).\n\nThe handler validates the JWT, checks that the organization in the\ntoken matches the subdomain, enqueues the raw payload in\n`webhook_queue` for asynchronous processing, and returns 200\nimmediately. Actual status-event handling happens out-of-band in a\nworker."
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{ \"ok\": true }"
                        },
                        {
                            "name": "Token required / invalid token payload",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/webhook/{{token}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "webhook",
                                        "{{token}}"
                                    ]
                                },
                                "description": "Inbound webhook endpoint that providers (Twilio, SendGrid,\nWhatsApp Business, etc.) post delivery/status callbacks to. The\n`token` in the URL is a Guper-issued JWT that carries\n`{ o: organization, d: dispatcher_id }` — it authenticates the\ncaller without an `x-guper-authorization` header (providers can't\nsign requests on our behalf).\n\nThe handler validates the JWT, checks that the organization in the\ntoken matches the subdomain, enqueues the raw payload in\n`webhook_queue` for asynchronous processing, and returns 200\nimmediately. Actual status-event handling happens out-of-band in a\nworker."
                            },
                            "status": "Bad Request",
                            "code": 400,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": ""
                        },
                        {
                            "name": "Invalid token",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/webhook/{{token}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "webhook",
                                        "{{token}}"
                                    ]
                                },
                                "description": "Inbound webhook endpoint that providers (Twilio, SendGrid,\nWhatsApp Business, etc.) post delivery/status callbacks to. The\n`token` in the URL is a Guper-issued JWT that carries\n`{ o: organization, d: dispatcher_id }` — it authenticates the\ncaller without an `x-guper-authorization` header (providers can't\nsign requests on our behalf).\n\nThe handler validates the JWT, checks that the organization in the\ntoken matches the subdomain, enqueues the raw payload in\n`webhook_queue` for asynchronous processing, and returns 200\nimmediately. Actual status-event handling happens out-of-band in a\nworker."
                            },
                            "status": "Unauthorized",
                            "code": 401,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": ""
                        },
                        {
                            "name": "Organization mismatch",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/webhook/{{token}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "webhook",
                                        "{{token}}"
                                    ]
                                },
                                "description": "Inbound webhook endpoint that providers (Twilio, SendGrid,\nWhatsApp Business, etc.) post delivery/status callbacks to. The\n`token` in the URL is a Guper-issued JWT that carries\n`{ o: organization, d: dispatcher_id }` — it authenticates the\ncaller without an `x-guper-authorization` header (providers can't\nsign requests on our behalf).\n\nThe handler validates the JWT, checks that the organization in the\ntoken matches the subdomain, enqueues the raw payload in\n`webhook_queue` for asynchronous processing, and returns 200\nimmediately. Actual status-event handling happens out-of-band in a\nworker."
                            },
                            "status": "Forbidden",
                            "code": 403,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": ""
                        }
                    ]
                },
                {
                    "name": "Send PIN (WhatsApp)",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "x-guper-authorization",
                                "value": "{{x-guper-authorization}}",
                                "type": "text",
                                "description": "User token issued by Guper."
                            },
                            {
                                "key": "Content-Type",
                                "value": "{{Content-Type}}",
                                "type": "text",
                                "description": "Always `application/json` for endpoints that accept a JSON body."
                            }
                        ],
                        "url": {
                            "raw": "https://{{organization}}.myguper.com/api/sender/whatsapppin/{{pin}}",
                            "protocol": "https",
                            "host": [
                                "{{organization}}",
                                "myguper",
                                "com"
                            ],
                            "path": [
                                "api",
                                "sender",
                                "whatsapppin",
                                "{{pin}}"
                            ]
                        },
                        "description": "Sends a one-time numeric PIN over WhatsApp — counterpart of\n[Send PIN SMS](/docs/{lang}/api-reference/sender/smspin-sms). Routes\nthe message through the organization's WhatsApp provider settings\nand the WhatsApp PIN template.\n\nThe `pin` itself travels in the URL path so it never lands in the\nrequest body (helps with logging hygiene).",
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"cellphone\": \"5511987654321\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    },
                    "response": [
                        {
                            "name": "Queued",
                            "originalRequest": {
                                "method": "POST",
                                "header": [
                                    {
                                        "key": "x-guper-authorization",
                                        "value": "{{x-guper-authorization}}",
                                        "type": "text",
                                        "description": "User token issued by Guper."
                                    },
                                    {
                                        "key": "Content-Type",
                                        "value": "{{Content-Type}}",
                                        "type": "text",
                                        "description": "Always `application/json` for endpoints that accept a JSON body."
                                    }
                                ],
                                "url": {
                                    "raw": "https://{{organization}}.myguper.com/api/sender/whatsapppin/{{pin}}",
                                    "protocol": "https",
                                    "host": [
                                        "{{organization}}",
                                        "myguper",
                                        "com"
                                    ],
                                    "path": [
                                        "api",
                                        "sender",
                                        "whatsapppin",
                                        "{{pin}}"
                                    ]
                                },
                                "description": "Sends a one-time numeric PIN over WhatsApp — counterpart of\n[Send PIN SMS](/docs/{lang}/api-reference/sender/smspin-sms). Routes\nthe message through the organization's WhatsApp provider settings\nand the WhatsApp PIN template.\n\nThe `pin` itself travels in the URL path so it never lands in the\nrequest body (helps with logging hygiene).",
                                "body": {
                                    "mode": "raw",
                                    "raw": "{\n    \"cellphone\": \"5511987654321\"\n}",
                                    "options": {
                                        "raw": {
                                            "language": "json"
                                        }
                                    }
                                }
                            },
                            "status": "OK",
                            "code": 200,
                            "_postman_previewlanguage": "json",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "body": "{ \"id\": \"msg_01HXYZ\", \"channel\": \"whatsapp\", \"status\": \"queued\" }"
                        }
                    ]
                }
            ]
        }
    ],
    "variable": [
        {
            "key": "scheme",
            "value": "https",
            "type": "string"
        },
        {
            "key": "organization",
            "value": "acme",
            "type": "string"
        },
        {
            "key": "TID",
            "value": "tx_demo_a1b2c3d4",
            "type": "string"
        },
        {
            "key": "confirmToken",
            "value": "54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49",
            "type": "string"
        },
        {
            "key": "hash",
            "value": "h_demo_abc123def456",
            "type": "string"
        },
        {
            "key": "id",
            "value": "42",
            "type": "string"
        },
        {
            "key": "personId",
            "value": "1234",
            "type": "string"
        },
        {
            "key": "couponCode",
            "value": "DEMO20",
            "type": "string"
        },
        {
            "key": "transactionId",
            "value": "tx_demo_a1b2c3d4",
            "type": "string"
        },
        {
            "key": "dateStart",
            "value": "2024-04-01",
            "type": "string"
        },
        {
            "key": "dateEnd",
            "value": "2024-04-30",
            "type": "string"
        },
        {
            "key": "x-guper-authorization",
            "value": "48c70a3d6bc1d15104abfaee80c6010f348713f5315bfd12028c2455667685a2",
            "type": "string"
        },
        {
            "key": "Content-Type",
            "value": "application/json",
            "type": "string"
        },
        {
            "key": "User-Agent",
            "value": "guper-docs/2.x",
            "type": "string"
        },
        {
            "key": "environment",
            "value": "",
            "type": "string"
        }
    ]
}