{ "_type": "export", "__export_format": 4, "__export_date": "2026-11-03T12:00:00.000Z", "__export_source": "cupom.frontend", "resources": [ { "_id": "wrk_cupom_rest_api", "parentId": null, "modified": 1793707200000, "created": 1793707200000, "name": "Cupom REST API", "description": "Collection dos endpoints REST públicos do Cupom. Selecione o ambiente HML ou PRD e informe o token correspondente. O ambiente é resolvido pela API key.", "scope": "collection", "_type": "workspace" }, { "_id": "env_cupom_base", "parentId": "wrk_cupom_rest_api", "modified": 1793707200000, "created": 1793707200000, "name": "Base Environment", "data": { "base_url": "https://api.cupom.center", "token": "", "coupon_id": "00000000-0000-0000-0000-000000000000", "coupon_code": "CUPOM10", "coupon_code_2": "FRETEGRATIS", "issuance_id": "00000000-0000-0000-0000-000000000000", "operation_id": "00000000-0000-0000-0000-000000000000", "order_id": "order-001", "redemption_id": "00000000-0000-0000-0000-000000000000", "currency": "BRL", "partial_refund_external_id": "refund-001", "idempotency_key": "issuance-example-001" }, "dataPropertyOrder": { "&": [ "base_url", "token", "coupon_id", "coupon_code", "coupon_code_2", "issuance_id", "operation_id", "order_id", "redemption_id", "currency", "partial_refund_external_id", "idempotency_key" ] }, "color": null, "isPrivate": false, "metaSortKey": 1, "_type": "environment" }, { "_id": "env_cupom_hml", "parentId": "env_cupom_base", "modified": 1793707200000, "created": 1793707200000, "name": "HML", "data": { "base_url": "https://api.cupom.center", "token": "" }, "dataPropertyOrder": { "&": ["base_url", "token"] }, "color": "#3B82F6", "isPrivate": true, "metaSortKey": 1, "_type": "environment" }, { "_id": "env_cupom_prd", "parentId": "env_cupom_base", "modified": 1793707200000, "created": 1793707200000, "name": "PRD", "data": { "base_url": "https://api.cupom.center", "token": "" }, "dataPropertyOrder": { "&": ["base_url", "token"] }, "color": "#EF4444", "isPrivate": true, "metaSortKey": 2, "_type": "environment" }, { "_id": "fld_cupom_integration", "parentId": "wrk_cupom_rest_api", "modified": 1793707200000, "created": 1793707200000, "name": "Integração", "description": "Validação não faturável da API key e do escopo usado por conectores.", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": -5000, "_type": "request_group" }, { "_id": "fld_cupom_eligibility", "parentId": "wrk_cupom_rest_api", "modified": 1793707200000, "created": 1793707200000, "name": "Elegibilidade", "description": "Consultas de cupons elegíveis. Estes endpoints usam o método HTTP QUERY.", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": -4000, "_type": "request_group" }, { "_id": "fld_cupom_discounts", "parentId": "wrk_cupom_rest_api", "modified": 1793707200000, "created": 1793707200000, "name": "Descontos", "description": "Cálculo e reserva de descontos para carrinhos.", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": -3000, "_type": "request_group" }, { "_id": "fld_cupom_issuances", "parentId": "wrk_cupom_rest_api", "modified": 1793707200000, "created": 1793707200000, "name": "Emissões (cupom dinâmico)", "description": "Emissão, consulta e revogação de códigos individuais.", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": -2000, "_type": "request_group" }, { "_id": "fld_cupom_redemptions", "parentId": "wrk_cupom_rest_api", "modified": 1793707200000, "created": 1793707200000, "name": "Resgates e operações", "description": "Resgates, pagamentos, consulta de operação e estorno.", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": -1000, "_type": "request_group" }, { "_id": "req_cupom_integration_validate", "parentId": "fld_cupom_integration", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/integration", "name": "Validar integração", "description": "Valida a API key sem faturamento e retorna organização, ambiente, projeto, moeda, permissões e versão da API.", "method": "GET", "body": {}, "parameters": [], "headers": [{ "name": "Accept", "value": "application/json" }], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -1000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_eligible", "parentId": "fld_cupom_eligibility", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/eligibility", "name": "Consultar cupons elegíveis", "description": "Retorna os cupons elegíveis para o contexto e carrinho informados.", "method": "QUERY", "body": { "mimeType": "application/json", "text": "{\n \"context\": {\n \"user\": {\n \"id\": \"user-001\",\n \"age\": 30,\n \"sex\": \"other\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"pix\",\n \"cart\": [\n {\n \"id\": \"product-001\",\n \"quantity\": 2,\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n },\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\",\n \"public\": true\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 20\n }\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -3000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_unit_single", "parentId": "fld_cupom_eligibility", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/eligibility/units/single", "name": "Consultar um cupom elegível por unidade", "description": "Consulta e retorna um cupom público elegível para cada unidade.", "method": "QUERY", "body": { "mimeType": "application/json", "text": "{\n \"context\": {\n \"user\": {\n \"id\": \"user-001\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"pix\"\n },\n \"selection\": {\n \"priority\": \"total_discount\"\n },\n \"units\": [\n {\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\",\n \"products\": [\n {\n \"product_id\": \"product-001\",\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n }\n }\n ]\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -2000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_unit_multiple", "parentId": "fld_cupom_eligibility", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/eligibility/units/multiple", "name": "Consultar vários cupons elegíveis por unidade", "description": "Consulta e retorna múltiplos cupons públicos elegíveis para cada unidade.", "method": "QUERY", "body": { "mimeType": "application/json", "text": "{\n \"context\": {\n \"user\": {\n \"id\": \"user-001\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"credit_card\"\n },\n \"selection\": {\n \"max_coupons_per_unit\": 2,\n \"priority\": \"total_discount\"\n },\n \"units\": [\n {\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\",\n \"products\": [\n {\n \"product_id\": \"product-001\",\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n }\n }\n ]\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -1000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_discount_single", "parentId": "fld_cupom_discounts", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/discount/single", "name": "Calcular desconto com um cupom", "description": "Calcula e reserva um cupom no carrinho.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cart_id\": \"cart-001\",\n \"coupon_code\": \"{{ _.coupon_code }}\",\n \"context\": {\n \"user\": {\n \"id\": \"user-001\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"pix\",\n \"cart\": [\n {\n \"id\": \"product-001\",\n \"quantity\": 2,\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n },\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -2000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_discount_multiple", "parentId": "fld_cupom_discounts", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/discount/multiple", "name": "Calcular desconto com vários cupons", "description": "Calcula e reserva múltiplos cupons no carrinho.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cart_id\": \"cart-001\",\n \"coupon_codes\": [\n \"{{ _.coupon_code }}\",\n \"{{ _.coupon_code_2 }}\"\n ],\n \"context\": {\n \"user\": {\n \"id\": \"user-001\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"credit_card\",\n \"cart\": [\n {\n \"id\": \"product-001\",\n \"quantity\": 2,\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n },\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\"\n },\n \"selection\": {\n \"strategy\": \"highest_discount_per_product\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -1000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_issuance_create", "parentId": "fld_cupom_issuances", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/issuances", "name": "Criar emissão", "description": "Emite um código individual para uma oferta dinâmica. A mesma Idempotency-Key deve ser reutilizada somente ao repetir a mesma tentativa.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"coupon_id\": \"{{ _.coupon_id }}\",\n \"external_reference\": \"order-001\",\n \"subject\": {\n \"user_id\": \"user-001\",\n \"cart_id\": \"cart-001\"\n },\n \"cart\": [\n {\n \"id\": \"product-001\",\n \"quantity\": 2,\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n },\n \"valid_until\": \"2027-12-31T23:59:59Z\",\n \"metadata\": {\n \"source\": \"insomnia\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" }, { "name": "Idempotency-Key", "value": "{{ _.idempotency_key }}" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -3000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_issuance_get", "parentId": "fld_cupom_issuances", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/issuances/{{ _.issuance_id }}", "name": "Consultar emissão", "description": "Consulta uma emissão pelo identificador.", "method": "GET", "body": {}, "parameters": [], "headers": [{ "name": "Accept", "value": "application/json" }], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -2000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_issuance_revoke", "parentId": "fld_cupom_issuances", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/issuances/{{ _.issuance_id }}/revocations", "name": "Revogar emissão", "description": "Revoga uma emissão de forma idempotente.", "method": "POST", "body": {}, "parameters": [], "headers": [{ "name": "Accept", "value": "application/json" }], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -1000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_redeem_single", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/redeem/single", "name": "Resgatar um cupom", "description": "Resgata um cupom e opcionalmente registra o pagamento na mesma operação.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cart_id\": \"cart-001\",\n \"order_id\": \"{{ _.order_id }}\",\n \"coupon_code\": \"{{ _.coupon_code }}\",\n \"context\": {\n \"user\": {\n \"id\": \"user-001\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"pix\",\n \"cart\": [\n {\n \"id\": \"product-001\",\n \"quantity\": 2,\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n },\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -5000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_redeem_multiple", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/redeem/multiple", "name": "Resgatar vários cupons", "description": "Resgata múltiplos cupons em uma única operação.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cart_id\": \"cart-001\",\n \"order_id\": \"{{ _.order_id }}\",\n \"coupon_codes\": [\n \"{{ _.coupon_code }}\",\n \"{{ _.coupon_code_2 }}\"\n ],\n \"context\": {\n \"user\": {\n \"id\": \"user-001\"\n },\n \"attributes\": {},\n \"location\": {\n \"country\": \"BR\",\n \"state\": \"SP\",\n \"city\": \"Sao Paulo\"\n },\n \"payment_method\": \"credit_card\",\n \"cart\": [\n {\n \"id\": \"product-001\",\n \"quantity\": 2,\n \"unitary_price\": 49.90\n }\n ],\n \"shipping\": {\n \"amount\": 12.50\n },\n \"unit_id\": \"unit-001\",\n \"brand_id\": \"brand-001\"\n },\n \"selection\": {\n \"strategy\": \"highest_discount_per_product\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -4000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_operation_get", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/operations/{{ _.operation_id }}", "name": "Consultar operação", "description": "Consulta o estado atual de uma operação de resgate.", "method": "GET", "body": {}, "parameters": [], "headers": [{ "name": "Accept", "value": "application/json" }], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -3000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_operation_get_by_order", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/operations/by-order/{{ _.order_id }}", "name": "Consultar operação pelo pedido", "description": "Recupera uma operação pelo order_id após timeout ou repetição incerta do resgate.", "method": "GET", "body": {}, "parameters": [], "headers": [{ "name": "Accept", "value": "application/json" }], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -2500, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_operation_payment", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/operations/{{ _.operation_id }}/payments", "name": "Registrar pagamento", "description": "Registra o pagamento de uma operação de resgate. Use a moeda retornada em project.currency por Validar integração.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"external_id\": \"payment-001\",\n \"method\": \"pix\",\n \"amount\": 99.80,\n \"currency\": \"{{ _.currency }}\",\n \"paid_at\": \"2026-11-03T12:00:00Z\"\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -2000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_operation_partial_refund", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/operations/{{ _.operation_id }}/partial-refunds", "name": "Registrar estorno parcial", "description": "Registra de forma idempotente as quantidades e parcelas de desconto devolvidas. Requer pagamento confirmado.", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"external_id\": \"{{ _.partial_refund_external_id }}\",\n \"redemptions\": [\n {\n \"redemption_id\": \"{{ _.redemption_id }}\",\n \"items\": [\n {\n \"line_number\": 1,\n \"quantity\": 1,\n \"discount_amount\": 5.00\n }\n ],\n \"shipping_discount_amount\": 0.00\n }\n ]\n}" }, "parameters": [], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -1500, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" }, { "_id": "req_cupom_operation_refund", "parentId": "fld_cupom_redemptions", "modified": 1793707200000, "created": 1793707200000, "url": "{{ _.base_url }}/v1/coupon/operations/{{ _.operation_id }}/refunds", "name": "Estornar operação", "description": "Libera os usos e budgets consumidos. O backend classifica como cancelamento sem pagamento ou estorno com pagamento confirmado.", "method": "POST", "body": {}, "parameters": [], "headers": [{ "name": "Accept", "value": "application/json" }], "authentication": { "type": "bearer", "token": "{{ _.token }}", "prefix": "Bearer", "disabled": false }, "metaSortKey": -1000, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "_type": "request" } ] }