{ "item": [ { "id": "f248a23c-65c3-4b91-96e5-075fd866fa23", "name": "Perfil", "description": { "content": "Perfil de los clientes del comercio.", "type": "text/plain" }, "item": [ { "id": "cb5fcac6-94f5-4e55-935d-c55cbd866319", "name": "Endpoint que permite obtener el total de clientes de un comercio", "request": { "name": "Endpoint que permite obtener el total de clientes de un comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId", "info", "behavioral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "85163e91-8543-4759-93cb-9252b03e9464", "name": "Successful", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId", "info", "behavioral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"totalClients\": 20\n },\n \"message\": \"Operation executed successfully\",\n \"statusCode\": 200\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c51cc5a-e81a-463e-9abe-5b28e9fb1436", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId", "info", "behavioral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"message\": \"Bad request\",\n \"error\": \"Invalid request\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0871af-fbab-460d-8dc7-ba0d34d64708", "name": "UnAuthorized", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId", "info", "behavioral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b2bff92-3419-4680-b12b-eda9b18177d3", "name": "Endpoint que permite consultar los géneros y los grupos de edades por comercio", "request": { "name": "Endpoint que permite consultar los géneros y los grupos de edades por comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "clients", "commerce", ":commerceId", "info", "demographic" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "branchId", "value": "", "description": "ID de la sucursal (opcional)." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "58caf428-dc3a-40f7-a446-cd931cce3ab8", "name": "Successful", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "commerce", ":commerceId", "info", "demographic" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 4663,\n \"message\": \"string\",\n \"data\": {\n \"genders\": [\n {\n \"id\": \"1\",\n \"name\": \"Male\",\n \"total\": 100,\n \"percentage\": \"50%\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Male\",\n \"total\": 100,\n \"percentage\": \"50%\"\n }\n ],\n \"ages\": [\n {\n \"id\": \"1\",\n \"name\": \"18-25\",\n \"total\": 50,\n \"percentage\": \"25%\"\n },\n {\n \"id\": \"1\",\n \"name\": \"18-25\",\n \"total\": 50,\n \"percentage\": \"25%\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ed4653c-521e-47d5-b117-77346a624d59", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "commerce", ":commerceId", "info", "demographic" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"message\": \"Bad request\",\n \"error\": \"Invalid request\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cf3b44d-dbe7-419c-88a2-4ea298a7499d", "name": "UnAuthorized", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "commerce", ":commerceId", "info", "demographic" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3eda376a-b6e8-45b9-b74f-948f419b73dd", "name": "Endpoint que permite consultar las estadísticas RFM por comercio", "request": { "name": "Endpoint que permite consultar las estadísticas RFM por comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "clients", "rfm", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "branchId", "value": "", "description": "ID de la sucursal (opcional)." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "0cbd8a30-5d16-478d-bfd0-edf57e4e39fa", "name": "Successful", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "rfm", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 1426,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978eaaed-dd7c-4078-8ffc-f2ee02a4f072", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "rfm", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"message\": \"Bad request\",\n \"error\": \"Invalid request\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d016587-04f9-4465-b428-715b2e3adf4c", "name": "UnAuthorized", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "rfm", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9466b8-0931-4b2e-a014-fe433a0543e5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "rfm", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "branchId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 500,\n \"message\": \"Internal server error\",\n \"error\": \"Internal server error\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "862b8a9c-8cb8-49c8-b720-ee9bd2a3de21", "name": "Endpoint que permite actualizar el estado de un cliente para un comercio", "request": { "name": "Endpoint que permite actualizar el estado de un cliente para un comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "clients", "status", ":userId", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerceId", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) ID del usuario" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"createdAfter\": \"\",\n \"createdBefore\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"idFranchise\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9f5cd919-b55c-4e47-b5ea-e98e93ee1c34", "name": "Successful", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "status", ":userId", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) ID del usuario" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"createdAfter\": \"\",\n \"createdBefore\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"idFranchise\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"message\": \"Operation executed successfully\",\n \"data\": \"response\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06fea11d-a0f1-460d-87ef-721ab38ba86c", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "status", ":userId", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) ID del usuario" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"createdAfter\": \"\",\n \"createdBefore\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"idFranchise\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"message\": \"Bad request\",\n \"error\": \"Invalid request\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e36184-1cd5-4726-9b37-4a71f5839a6a", "name": "UnAuthorized", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "status", ":userId", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) ID del usuario" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"createdAfter\": \"\",\n \"createdBefore\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"idFranchise\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee91d63-cf71-4bb9-a61e-2625c7899afe", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", "status", ":userId", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) ID del usuario" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"createdAfter\": \"\",\n \"createdBefore\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"idFranchise\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 500,\n \"message\": \"Internal server error\",\n \"error\": \"Internal server error\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3f62110-0061-49be-a333-66f504148526", "name": "Endpoint que permite obtener listado de clientes de un comercio", "request": { "name": "Endpoint que permite obtener listado de clientes de un comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"createdAfter\": \"\",\n \"createdBefore\": \"\",\n \"pageSize\": \"\",\n \"currentPage\": \"\",\n \"idFranchise\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d9e96ce-818d-4220-b812-21faddcf9f0a", "name": "Successful", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currentPage\": 1,\n \"pageSize\": 20,\n \"sortType\": \"desc\",\n \"sortField\": \"lifeTimeValue\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"name\": \"Alberto Urueta\",\n \"ageGroup\": \"25-34\",\n \"age\": 33,\n \"gender\": \"male\",\n \"statusRFM\": \"Leal\",\n \"averageTicket\": 17091862.652777776,\n \"lifeTimeValue\": 1230614111,\n \"lastRating\": 8,\n \"numberOfVisits\": 111,\n \"lastVisit\": \"2019-06-06T00:00:00+00:00\",\n \"pointsAvailable\": -5,\n \"usedPoints\": 6014,\n \"expiredPoints\": 1225159,\n \"status\": \"activa\",\n \"birthday\": \"1991-12-18T00:00:00+00:00\",\n \"email\": \"cenarius12@gmail.com\",\n \"phone\": \"3002575486\",\n \"documentNumber\": \"1143356182\",\n \"firstName\": \"Alberto\",\n \"lastName\": \"Urueta\",\n \"documentType\": \"Cédula Ciudadanía\",\n \"location\": \"\"\n }\n ],\n \"message\": \"Operation executed successfully\",\n \"pagination\": {\n \"currentPage\": 1,\n \"hasNextPage\": true,\n \"hasPreviousPage\": false,\n \"pageSize\": 20\n },\n \"statusCode\": 200\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81835cef-b78a-4b8a-81ee-f63798828ee4", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currentPage\": 1,\n \"pageSize\": 20,\n \"sortType\": \"desc\",\n \"sortField\": \"lifeTimeValue\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"message\": \"Bad request\",\n \"error\": \"Invalid request\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14c4429-2f38-41ea-a806-de358caf336d", "name": "UnAuthorized", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currentPage\": 1,\n \"pageSize\": 20,\n \"sortType\": \"desc\",\n \"sortField\": \"lifeTimeValue\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3890fa46-51fd-484b-a7ad-be4558482a1b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currentPage\": 1,\n \"pageSize\": 20,\n \"sortType\": \"desc\",\n \"sortField\": \"lifeTimeValue\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 500,\n \"message\": \"Internal server error\",\n \"error\": \"Internal server error\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bca53241-0eb8-49b6-b4fc-d8c48d400d26", "name": "Audiencias", "description": { "content": "Crear, consultar y mantener audiencias.", "type": "text/plain" }, "item": [ { "id": "70aaa61b-0c0c-4b23-8b61-a196216154d5", "name": "Crea una nueva audiencia (V2) - Soporta audiencias legacy (applied_filters) y groups (condition tree)", "request": { "name": "Crea una nueva audiencia (V2) - Soporta audiencias legacy (applied_filters) y groups (condition tree)", "description": { "content": "Este endpoint soporta **dos formatos** de cuerpo detectados automáticamente por la presencia de la clave `groups`:\n\n### Formato groups (condition tree builder)\nPersiste un segmento activo con árbol de condiciones (`condition_tree`) y filtros mapeados legacy (`filters[]`).\n- **Detección**: cuerpo contiene la clave `groups`\n- `type`: debe ser `static` o `dynamic` (requerido; `manual` no permitido)\n- `name`: requerido, trimmed antes de validación de unicidad (case-insensitive)\n- `groups[]`: árbol de condiciones; mínimo una hoja completa y mapenable\n- `member_count` siempre `0` en el 201 (eventual consistency via pipeline async)\n\n### Formato Legacy (V2 — applied_filters)\nComportamiento previo sin cambios:\n- **Detección**: cuerpo NO contiene la clave `groups`\n- `audience_type`: `dynamic`, `static` o `manual`\n- `filters_applied`: requerido para dynamic/static\n- `uids`: requerido para manual\n", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) ID del comercio" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"groups\": [\n {\n \"operator\": \"\",\n \"conditions\": [\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"operator\": \"\",\n \"conditions\": [\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"interGroupOperator\": \"and\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "634e92ed-2966-47e2-9328-f60b3cc3c42e", "name": "Audiencia creada con éxito", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"segmentation_id\": \"664abc123def456\",\n \"status\": \"active\",\n \"created_at\": \"2026-07-07T13:00:00Z\",\n \"member_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c550dcde-6a7d-4913-95f6-db698e2dc36b", "name": "Error de validación", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El campo 'type' es requerido\",\n \"data\": {\n \"code\": \"ErrMissingType\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7474bb-fec3-40b0-b4b7-fe999026254a", "name": "Filtro desconocido o usuario no pertenece al comercio (legacy)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El filtro enviado es desconocido\",\n \"data\": {\n \"code\": \"UnknowFilter: city_id\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "749527b8-52f4-4acd-bea6-b0395b5de885", "name": "Error semántico — nombre duplicado o árbol incompleto (groups create)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Ya existe un segmento con ese nombre para este comercio\",\n \"data\": {\n \"code\": \"ErrDuplicateSegmentName\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad8453ac-2a5d-4a44-b675-89bcbffe2db5", "name": "Error inesperado o fallo de persistencia", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Error al persistir el segmento\",\n \"data\": {\n \"code\": \"ErrPersistenceFailure\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8090b215-d905-4f11-98fc-aa9e2c52cd35", "name": "Obtiene un segmento por ID (V2) — incluye árbol de condiciones y metadata de conteo", "request": { "name": "Obtiene un segmento por ID (V2) — incluye árbol de condiciones y metadata de conteo", "description": { "content": "Retorna un único segmento filtrado por `_id` **y** `commerce_id` en una sola consulta.\nEl árbol de condiciones persistido se reconstruye en el formato `condition_tree` (mapper inverso, simétrico al de creación).\nNo existe recuento en vivo: `member_count` refleja el último valor persistido y `counters_run_at`/`counters_run_id`\nreflejan la última corrida del job de conteo (pueden ser `null`/ausentes si aún no ha corrido).\nEl 404 tiene la misma forma tanto si el segmento no existe como si pertenece a otro comercio (sin fuga de información).\n", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "c9ddf369-81e3-4c48-9e89-1ca9d3a34652", "name": "Segmento encontrado", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status_code\": 200,\n \"data\": {\n \"id\": \"665f1a2b3c4d5e6f7a8b9c0d\",\n \"name\": \"Clientes VIP Bogotá\",\n \"type\": \"dynamic\",\n \"status\": \"active\",\n \"condition_tree\": {\n \"interGroupOperator\": \"AND\",\n \"groups\": [\n {\n \"operator\": \"OR\",\n \"conditions\": [\n {\n \"attributeId\": \"12\",\n \"field\": \"total_spending\",\n \"operator\": \"gte\",\n \"dataType\": \"number\",\n \"value\": 100000\n }\n ]\n }\n ]\n },\n \"condition_tree_available\": true,\n \"member_count\": 42,\n \"created_at\": \"2026-07-01T10:00:00Z\",\n \"updated_at\": \"2026-07-05T08:30:00Z\",\n \"counters_run_at\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b65ed393-d052-49f6-8d10-b17a0727ef0a", "name": "commerce_id inválido (no entero o <= 0) o segmentationId vacío/hex inválido", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El identificador del comercio es inválido\",\n \"data\": {\n \"code\": \"ErrInvalidCommerceID\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e838276b-d8d7-4ccc-ba52-0dbf0a51b8ff", "name": "Segmento no encontrado (no existe o pertenece a otro comercio — misma forma en ambos casos)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El segmento no existe\",\n \"data\": {\n \"code\": \"ErrSegmentationNotFound\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b7b7b19-7e99-4ff9-b47e-c145918424b1", "name": "Error inesperado consultando el segmento", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Error al obtener el segmento\",\n \"data\": {\n \"code\": \"ErrGetSegmentationFailure\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2fb6bfb-e9e0-4623-a28f-7d9aa5caf118", "name": "Actualiza (full-replace) un segmento existente por ID (V2)", "request": { "name": "Actualiza (full-replace) un segmento existente por ID (V2)", "description": { "content": "Edita un segmento identificado por `_id` **y** `commerce_id` en una sola operación. El cuerpo tiene el\nmismo formato groups (condition tree) usado en la creación — reemplaza `name`, `type`, `condition_tree`\ny `filters[]` por completo.\n\n- El recuento de miembros (`member_count`) se **recalcula de forma síncrona** en cada edición, tanto para\n `static` como para `dynamic` — la respuesta siempre refleja el conteo fresco.\n- Si `type` es `static`, además se dispara en segundo plano el refresco de buckets de audiencia (no bloquea\n la respuesta 200 ni afecta el `member_count` ya persistido).\n- El nombre debe ser único (case-insensitive) entre los demás segmentos del comercio, **excluyendo el\n propio segmento** — renombrar un segmento a su propio nombre actual está permitido.\n- El 404 tiene la misma forma tanto si el segmento no existe como si pertenece a otro comercio (sin fuga\n de información).\n- Si el segmento tiene entradas en `consumers[]` (registro de ocupación), la edición se bloquea con `422`\n `ErrSegmentationInUse` — mismo gate de ocupación que el delete v2. Cualquier PATCH queda bloqueado\n mientras el segmento esté marcado en uso.\n", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"groups\": [\n {\n \"operator\": \"\",\n \"conditions\": [\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"operator\": \"\",\n \"conditions\": [\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"attributeId\": \"\",\n \"field\": \"\",\n \"operator\": \"\",\n \"dataType\": \"\",\n \"value\": {},\n \"subFilters\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"interGroupOperator\": \"and\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b156f365-5be1-4584-b505-ca48fc208ab9", "name": "Segmento actualizado con éxito — member_count refleja el recuento fresco", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status_code\": 200,\n \"data\": {\n \"id\": \"665f1a2b3c4d5e6f7a8b9c0d\",\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"status\": \"active\",\n \"condition_tree\": {\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n },\n \"condition_tree_available\": true,\n \"member_count\": 77,\n \"created_at\": \"2026-07-01T10:00:00Z\",\n \"updated_at\": \"2026-07-09T06:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcf192d0-4b2a-43c5-b196-5dcb28ea0599", "name": "commerce_id/segmentationId inválido, o 'type' ausente/inválido", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El identificador del comercio es inválido\",\n \"data\": {\n \"code\": \"ErrInvalidCommerceID\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b98a20c-f4f3-462b-a90e-5c59c8930850", "name": "Segmento no encontrado (no existe o pertenece a otro comercio — misma forma en ambos casos)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El segmento no existe\",\n \"data\": {\n \"code\": \"ErrSegmentationNotFound\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34555537-3a12-420c-88a0-bcde0f4f687c", "name": "Error semántico — segmento en uso, nombre duplicado (excluyendo el propio segmento) o árbol incompleto", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El segmento está en uso y no puede modificarse\",\n \"data\": {\n \"code\": \"ErrSegmentationInUse\",\n \"blocking_reasons\": [\n \"occupancy\"\n ],\n \"consumers\": [\n {\n \"consumer_type\": \"leaderboard\",\n \"consumer_id\": \"lb_123\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2364796-f4f0-4f15-85e2-65f162dbd0c4", "name": "Fallo en el recálculo síncrono del conteo o en la persistencia — no se escribe nada", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Clientes VIP\",\n \"type\": \"dynamic\",\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Error al actualizar el segmento\",\n \"data\": {\n \"code\": \"ErrUpdateSegmentationFailure\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea443be4-2902-4ceb-90d8-6580f310bfdf", "name": "Elimina permanentemente un segmento por ID (V2) — dual gate + hard delete atómico", "request": { "name": "Elimina permanentemente un segmento por ID (V2) — dual gate + hard delete atómico", "description": { "content": "Elimina el segmento identificado por `_id` **y** `commerce_id` en una sola operación atómica. No\nconfundir con el endpoint legacy `DELETE /segmentations/{segmentationID}` (sin scope de comercio,\nmapeo de errores plano) — ambos coexisten, el legacy queda sin cambios.\n\nLa eliminación solo procede si ambos \"gates\" pasan, evaluados en orden secuencial (short-circuit —\nsi el gate 1 bloquea, el gate 2 nunca se evalúa):\n\n1. **Gate 1 — registro de ocupación**: el segmento no debe tener entradas en `consumers[]`\n (ver `PUT .../occupancy`).\n2. **Gate 2 — campañas activas (legacy)**: el segmento no debe estar vinculado a una campaña con\n `send_status` en `programmed`, `processing` o `in_approval`.\n\nSi cualquiera de los dos gates bloquea, la respuesta es `422` con `blocking_reasons` indicando cuál\ngate falló y, cuando el bloqueo es por ocupación, la lista `consumers`. El detalle de campañas\nlegacy **no** se expone en el contrato (migración suave: gate 2 sigue bloqueando internamente\nhasta que campañas adopte ocupación). Si ambos pasan, el borrado es\nun `DeleteOne` de un solo documento — no hay borrado parcial si la operación falla (`500`).\n\nEl filtro del `DeleteOne` está condicionado a `consumers` vacío/ausente además de `_id`+`commerce_id`,\ncerrando la ventana de carrera entre la lectura del gate 1 y el borrado: si un `mark` concurrente\nllega justo antes del `DeleteOne`, el filtro no matchea ningún documento (`DeletedCount==0`) en vez de\nborrar un segmento que acaba de pasar a estar en uso. En ese caso el servicio reevalúa: si el segmento\nahora tiene `consumers` → `422` ocupación; si ya no existe/no es de ese comercio → `404`; cualquier\notro caso → `500`.\n\nPara audiencias estáticas con buckets materializados, la limpieza de `segmentation_buckets` se\ndispara en segundo plano (fire-and-forget) y no bloquea la respuesta `204`.\n\nEl `404` tiene la misma forma tanto si el segmento no existe como si pertenece a otro comercio (sin\nfuga de información).\n", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento a eliminar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "b6d7aa3e-155e-48ad-8adc-3df8e0f165a0", "name": "Segmento eliminado con éxito — sin cuerpo de respuesta", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento a eliminar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54870fb0-61d6-4b8a-b39d-5d4158584761", "name": "commerce_id inválido (no entero o <= 0) o segmentationId vacío/hex inválido", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento a eliminar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El identificador del comercio es inválido\",\n \"data\": {\n \"code\": \"ErrInvalidCommerceID\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35f66870-4aaa-4076-8a55-7aff52f4b27a", "name": "Segmento no encontrado (no existe o pertenece a otro comercio — misma forma en ambos casos)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento a eliminar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El segmento no existe\",\n \"data\": {\n \"code\": \"ErrSegmentationNotFound\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799b542e-2b77-4c43-b463-1d8a9f29aa1e", "name": "Segmento en uso — bloqueado por ocupación y/o campañas activas (dual gate)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento a eliminar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El segmento está en uso y no puede modificarse\",\n \"data\": {\n \"code\": \"ErrSegmentationInUse\",\n \"blocking_reasons\": [\n \"occupancy\"\n ],\n \"consumers\": [\n {\n \"consumer_type\": \"leaderboard\",\n \"consumer_id\": \"lb_123\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "738c0d16-7490-43d5-84fb-4bdd7f7f60ef", "name": "Fallo externo o de borrado — el segmento queda intacto (sin borrado parcial).\nCódigos diferenciados: `ErrCampaignsCheckFailure` (gate 2 / ms-campaigns inalcanzable o no-200)\nvs `ErrDeleteSegmentationFailure` (persistencia / re-eval inesperado).\n", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento a eliminar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Error al consultar campañas asociadas al segmento\",\n \"data\": {\n \"code\": \"ErrCampaignsCheckFailure\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f61ceb7f-7841-422f-885d-06039aa8b07f", "name": "Duplica un segmento existente en una copia independiente (V2)", "request": { "name": "Duplica un segmento existente en una copia independiente (V2)", "description": { "content": "Crea una copia independiente del segmento identificado por `_id` **y** `commerce_id`. El cuerpo de la\npetición se **ignora por completo** — no se acepta nombre, tipo ni árbol de condiciones definidos por el\nusuario en esta llamada (el nombre se podrá editar luego vía el endpoint de actualización).\n\n- **Nombre**: se genera automáticamente como `\"Copia de {nombre origen}\"`; si ya existe un segmento con\n ese nombre para el comercio, se agrega un sufijo numérico (`\"(2)\"`, `\"(3)\"`, …) hasta encontrar uno\n disponible. Duplicar una copia encadena el prefijo (`\"Copia de Copia de X\"`), nunca lo deduplica.\n- **Árbol de condiciones**: se copia **verbatim** desde el origen — no se re-ejecuta ninguna validación\n de árbol; editar la copia o el origen después no afecta al otro.\n- **Tipo**: idéntico al del segmento origen (`static` o `dynamic`).\n- **Recuento de miembros**: se **recalcula de forma síncrona** en el momento de la duplicación, para\n `static` **y** `dynamic` — la respuesta siempre refleja el conteo fresco (nunca `0`).\n- Si el tipo resultante es `static`, además se dispara en segundo plano el pipeline de materialización de\n buckets de audiencia (no bloquea la respuesta `201`).\n- No se copia historial de recuento (`counters_run_at`/`counters_run_id`) ni membresía del origen.\n- El `404` tiene la misma forma tanto si el segmento no existe como si pertenece a otro comercio (sin\n fuga de información).\n", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento origen a duplicar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "id": "2b7c89c4-ae73-451b-bb66-4c62bc6eeb94", "name": "Segmento duplicado con éxito — nuevo id, nombre disambiguado, member_count fresco", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento origen a duplicar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status_code\": 201,\n \"data\": {\n \"id\": \"7a1b2c3d4e5f6a7b8c9d0e1f\",\n \"name\": \"Copia de Clientes VIP\",\n \"type\": \"dynamic\",\n \"status\": \"active\",\n \"condition_tree\": {\n \"interGroupOperator\": \"and\",\n \"groups\": [\n {\n \"operator\": \"and\",\n \"conditions\": [\n {\n \"field\": \"age\",\n \"operator\": \"gt\",\n \"dataType\": \"numeric\",\n \"value\": 30\n }\n ]\n }\n ]\n },\n \"condition_tree_available\": true,\n \"member_count\": 42,\n \"created_at\": \"2026-07-10T06:00:00Z\",\n \"updated_at\": \"2026-07-10T06:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0168e349-5952-4817-bd5d-bf38c8f12c9b", "name": "commerce_id inválido (no entero o <= 0) o segmentationId vacío/hex inválido", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento origen a duplicar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El identificador del comercio es inválido\",\n \"data\": {\n \"code\": \"ErrInvalidCommerceID\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2448c1e8-5161-425f-beb4-9c227c086d2d", "name": "Segmento no encontrado (no existe o pertenece a otro comercio — misma forma en ambos casos)", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento origen a duplicar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"El segmento no existe\",\n \"data\": {\n \"code\": \"ErrSegmentationNotFound\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f100e72-ef12-4001-9437-c900004fb98a", "name": "Fallo en el recálculo síncrono del conteo o en la persistencia — no se crea ningún registro parcial", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "v2", ":commerce_id", ":segmentationId", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) ID del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) ID del segmento origen a duplicar (ObjectID hexadecimal de Mongo)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Error al duplicar el segmento\",\n \"data\": {\n \"code\": \"ErrDuplicateSegmentationFailure\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6950bc3-5c4c-4c61-97e4-ade01c9cebf2", "name": "Retorna todas las segmentaciones del comercio", "request": { "name": "Retorna todas las segmentaciones del comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "segmentations", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "" }, { "disabled": false, "key": "sortField", "value": "" }, { "disabled": false, "key": "sortType", "value": "" }, { "disabled": false, "key": "search", "value": "" }, { "disabled": false, "key": "createdAfter", "value": "" }, { "disabled": false, "key": "createdBefore", "value": "" }, { "disabled": false, "key": "excludeOfferfitAudience", "value": "" }, { "disabled": false, "key": "includeAllSegment", "value": "false", "description": "Opt-in to prepend the synthetic `_all`/\"Todos\" row on page 1. Defaults to false." }, { "disabled": false, "key": "category", "value": "", "description": "(Required) Categoría de segmentación a filtrar: custom (personalizada), suggested (sugerida), manual (manual), all (todas las categorías)" } ], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerceId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "43ddcb0d-e429-45f8-a622-ffcaf40dfbe2", "name": "Listado de todas las segmentaciones del comercio", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "sortField", "value": "" }, { "key": "sortType", "value": "" }, { "key": "search", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "excludeOfferfitAudience", "value": "" }, { "key": "includeAllSegment", "value": "false" }, { "key": "category", "value": "all" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"pagination\": {\n \"totalItems\": 10,\n \"totalPages\": 10,\n \"page\": 1,\n \"pageSize\": 1,\n \"hasNextPage\": true,\n \"hasPreviousPage\": false\n },\n \"data\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"commerceId\": \"13\",\n \"branchId\": \"branch_123\",\n \"type\": \"dynamic\",\n \"category\": \"custom\",\n \"name\": \"Usuarios de bogotá\",\n \"totalClients\": 500,\n \"totalClientsSMS\": 450,\n \"totalClientsEmail\": 400,\n \"totalClientsOfferfit\": 50,\n \"totalClientsOfferfitSMS\": 45,\n \"totalClientsOfferfitEmail\": 40,\n \"contactableBauSMS\": 450,\n \"contactableBauEmail\": 400,\n \"contactableBauWhatsApp\": 480,\n \"createdAt\": \"2023-08-08T12:34:56Z\",\n \"version\": 1\n },\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"commerceId\": \"13\",\n \"branchId\": \"branch_123\",\n \"type\": \"dynamic\",\n \"category\": \"custom\",\n \"name\": \"Usuarios de bogotá\",\n \"totalClients\": 500,\n \"totalClientsSMS\": 450,\n \"totalClientsEmail\": 400,\n \"totalClientsOfferfit\": 50,\n \"totalClientsOfferfitSMS\": 45,\n \"totalClientsOfferfitEmail\": 40,\n \"contactableBauSMS\": 450,\n \"contactableBauEmail\": 400,\n \"contactableBauWhatsApp\": 480,\n \"createdAt\": \"2023-08-08T12:34:56Z\",\n \"version\": 1\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b02be3c-8380-4745-97ca-869f15d97b9c", "name": "Retorna el detalle de una segmentación específica del comercio", "request": { "name": "Retorna el detalle de una segmentación específica del comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "segmentations", ":segmentationId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "afc4e894-3169-41fa-9de8-1b4ca47c673b", "name": "Detalle de la segmentación solicitada", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", ":segmentationId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"data\": {\n \"_id\": \"66be774f971b7144a364cb85\",\n \"name\": \"prueba-lista-dinamica-and-or\",\n \"type\": \"dynamic\",\n \"category\": \"custom\",\n \"filtersApplied\": [\n {\n \"operator\": \"none\",\n \"filters\": [\n {\n \"name\": \"Género\",\n \"category\": \"demographic\",\n \"operator\": \"none\",\n \"type\": \"MultipleString\",\n \"field\": \"gender\",\n \"value\": \"string\"\n },\n {\n \"name\": \"Género\",\n \"category\": \"demographic\",\n \"operator\": \"none\",\n \"type\": \"MultipleString\",\n \"field\": \"gender\",\n \"value\": \"string\"\n }\n ]\n },\n {\n \"operator\": \"none\",\n \"filters\": [\n {\n \"name\": \"Género\",\n \"category\": \"demographic\",\n \"operator\": \"none\",\n \"type\": \"MultipleString\",\n \"field\": \"gender\",\n \"value\": \"string\"\n },\n {\n \"name\": \"Género\",\n \"category\": \"demographic\",\n \"operator\": \"none\",\n \"type\": \"MultipleString\",\n \"field\": \"gender\",\n \"value\": \"string\"\n }\n ]\n }\n ],\n \"createdAt\": \"2024-08-15T21:46:55Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "519920f3-abd8-42cb-b5b4-ecade9740110", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", ":segmentationId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": \"", "key": "segmentationId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e15239a0-ab80-477b-9bf0-a6d25db7f5e7", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", ":segmentationId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "segmentationId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": \"", "key": "commerceId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"Usuarios preferenciales\"\n },\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"name\": \"Usuarios preferenciales\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f0452e9-cea1-421f-ba06-959d7c652794", "name": "Retorna la información de los clientes de una segmentación del comercio", "request": { "name": "Retorna la información de los clientes de una segmentación del comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "segmentations", ":segmentationId", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSearch\": \"\",\n \"sortField\": \"\",\n \"sortType\": \"\",\n \"filters\": [\n {\n \"column\": \"\",\n \"items\": \"\"\n },\n {\n \"column\": \"\",\n \"items\": \"\"\n }\n ],\n \"page\": \"\",\n \"pageSize\": \"\",\n \"includeUsersOfferfit\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c91ea60c-2736-4cd0-b1ca-9f1d904c4aaf", "name": "información de los clientes de una segmentación del comercio", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", ":segmentationId", "clients", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSearch\": \"mariceth\",\n \"sortField\": \"name\",\n \"sortType\": \"asc\",\n \"filters\": [\n {\n \"column\": \"statusRfm\",\n \"items\": [\n \"Leal en potencia\"\n ]\n },\n {\n \"column\": \"statusRfm\",\n \"items\": [\n \"Leal en potencia\"\n ]\n }\n ],\n \"page\": 1,\n \"pageSize\": 10,\n \"includeUsersOfferfit\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"statusCode\": 200,\n \"message\": \"successfully executed action\",\n \"data\": [\n {\n \"id\": \"101285b493dc4b4da1fd87161e97ca71\",\n \"fullname\": \"Mariceth Cruz\",\n \"firstName\": \"Mariceth\",\n \"lastName\": \"Cruz\",\n \"ageGroup\": \"45+\",\n \"age\": 30,\n \"gender\": \"female\",\n \"statusRfm\": \"Leal en potencia\",\n \"lealStatus\": \"activo\",\n \"birthday\": \"1960-03-20\",\n \"email\": \"maricthcruz@hotmail.com\",\n \"phone\": \"3100031111\",\n \"documentNumber\": \"33333333\",\n \"documentType\": \"Cédula Ciudadanía\",\n \"city\": \"Barranquilla\",\n \"averageTicket\": 521008,\n \"totalSpending\": 521008,\n \"lastRating\": 4,\n \"visits\": 1,\n \"lastVisit\": \"2024-03-19\",\n \"activePoints\": 521,\n \"usedPoints\": 0,\n \"totalPoints\": 521,\n \"claimedPrizesCount\": 0\n },\n {\n \"id\": \"101285b493dc4b4da1fd87161e97ca71\",\n \"fullname\": \"Mariceth Cruz\",\n \"firstName\": \"Mariceth\",\n \"lastName\": \"Cruz\",\n \"ageGroup\": \"45+\",\n \"age\": 30,\n \"gender\": \"female\",\n \"statusRfm\": \"Leal en potencia\",\n \"lealStatus\": \"activo\",\n \"birthday\": \"1960-03-20\",\n \"email\": \"maricthcruz@hotmail.com\",\n \"phone\": \"3100031111\",\n \"documentNumber\": \"33333333\",\n \"documentType\": \"Cédula Ciudadanía\",\n \"city\": \"Barranquilla\",\n \"averageTicket\": 521008,\n \"totalSpending\": 521008,\n \"lastRating\": 4,\n \"visits\": 1,\n \"lastVisit\": \"2024-03-19\",\n \"activePoints\": 521,\n \"usedPoints\": 0,\n \"totalPoints\": 521,\n \"claimedPrizesCount\": 0\n }\n ],\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"hasNextPage\": true,\n \"hasPreviousPage\": false\n }\n },\n {\n \"statusCode\": 200,\n \"message\": \"successfully executed action\",\n \"data\": [\n {\n \"id\": \"101285b493dc4b4da1fd87161e97ca71\",\n \"fullname\": \"Mariceth Cruz\",\n \"firstName\": \"Mariceth\",\n \"lastName\": \"Cruz\",\n \"ageGroup\": \"45+\",\n \"age\": 30,\n \"gender\": \"female\",\n \"statusRfm\": \"Leal en potencia\",\n \"lealStatus\": \"activo\",\n \"birthday\": \"1960-03-20\",\n \"email\": \"maricthcruz@hotmail.com\",\n \"phone\": \"3100031111\",\n \"documentNumber\": \"33333333\",\n \"documentType\": \"Cédula Ciudadanía\",\n \"city\": \"Barranquilla\",\n \"averageTicket\": 521008,\n \"totalSpending\": 521008,\n \"lastRating\": 4,\n \"visits\": 1,\n \"lastVisit\": \"2024-03-19\",\n \"activePoints\": 521,\n \"usedPoints\": 0,\n \"totalPoints\": 521,\n \"claimedPrizesCount\": 0\n },\n {\n \"id\": \"101285b493dc4b4da1fd87161e97ca71\",\n \"fullname\": \"Mariceth Cruz\",\n \"firstName\": \"Mariceth\",\n \"lastName\": \"Cruz\",\n \"ageGroup\": \"45+\",\n \"age\": 30,\n \"gender\": \"female\",\n \"statusRfm\": \"Leal en potencia\",\n \"lealStatus\": \"activo\",\n \"birthday\": \"1960-03-20\",\n \"email\": \"maricthcruz@hotmail.com\",\n \"phone\": \"3100031111\",\n \"documentNumber\": \"33333333\",\n \"documentType\": \"Cédula Ciudadanía\",\n \"city\": \"Barranquilla\",\n \"averageTicket\": 521008,\n \"totalSpending\": 521008,\n \"lastRating\": 4,\n \"visits\": 1,\n \"lastVisit\": \"2024-03-19\",\n \"activePoints\": 521,\n \"usedPoints\": 0,\n \"totalPoints\": 521,\n \"claimedPrizesCount\": 0\n }\n ],\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"hasNextPage\": true,\n \"hasPreviousPage\": false\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b284bd7-c19b-474e-b8f2-348683f8678b", "name": "Consulta los filtros de las segmentaciones basado en el id del comercio y clasificados por la categoria\ndel filtro", "request": { "name": "Consulta los filtros de las segmentaciones basado en el id del comercio y clasificados por la categoria\ndel filtro", "description": {}, "url": { "path": [ "v1", "crm", "api", "segmentations", "filters", "allowed-filters", ":idComercio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "idComercio", "description": "(Required) ID del comercio" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "85b611b4-ffbb-40d6-9af3-90543edd503a", "name": "Successful", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "filters", "allowed-filters", ":idComercio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idComercio", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"data\": [\n {\n \"category\": \"psicographic\",\n \"componentId\": \"leal-list-psicographic\",\n \"filters\": [\n {\n \"name\": \"Etiquetas\",\n \"description\": \"Métrica de marketing que significa Recencia, Frecuencia, Monetario.\",\n \"icon\": \"local_offer\",\n \"componentId\": \"leal-item-tags\",\n \"types\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"name\": \"Etiquetas\",\n \"description\": \"Métrica de marketing que significa Recencia, Frecuencia, Monetario.\",\n \"icon\": \"local_offer\",\n \"componentId\": \"leal-item-tags\",\n \"types\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ]\n },\n {\n \"category\": \"psicographic\",\n \"componentId\": \"leal-list-psicographic\",\n \"filters\": [\n {\n \"name\": \"Etiquetas\",\n \"description\": \"Métrica de marketing que significa Recencia, Frecuencia, Monetario.\",\n \"icon\": \"local_offer\",\n \"componentId\": \"leal-item-tags\",\n \"types\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"name\": \"Etiquetas\",\n \"description\": \"Métrica de marketing que significa Recencia, Frecuencia, Monetario.\",\n \"icon\": \"local_offer\",\n \"componentId\": \"leal-item-tags\",\n \"types\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"weight\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "970a5330-08e3-4e7d-8bce-a3072f1a00e3", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "filters", "allowed-filters", ":idComercio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idComercio", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": \"", "key": "idComercio", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a437ba22-d9ff-4590-8296-15f33d2c3219", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "filters", "allowed-filters", ":idComercio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idComercio", "description": "(Required) ID del comercio" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": \"", "key": "filterName", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "b5e23f48-05bd-47af-88c1-b89d54bee698", "name": "Success Response", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "filters", ":filterName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "filterName", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Bogotá\"\n },\n {\n \"id\": 2,\n \"name\": \"Medellín\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "671a8bbf-a613-4a7e-be1b-65045079297a", "name": "Consulta audiencias sugeridas por Leal, para luego crearlas al comercio", "request": { "name": "Consulta audiencias sugeridas por Leal, para luego crearlas al comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "segmentations", "suggested", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerceId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "de1fe551-04a4-4e3e-93e8-42c3c37571fc", "name": "Created successfully", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", "suggested", ":commerceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerceId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": \"\",\n \"filters\": [\n {\n \"field\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"field\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7ebed2a3-4447-4815-94c5-78035b0c9a7b", "name": "total de clientes para unos filtros específicos", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "segmentations", ":commerceId", "total-clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactabilityChannel\": \"all\",\n \"filters\": [\n {\n \"field\": \"last_rating\",\n \"type\": \"MultipleNumber\",\n \"value\": [\n 8,\n 9,\n 10\n ]\n },\n {\n \"field\": \"last_rating\",\n \"type\": \"MultipleNumber\",\n \"value\": [\n 8,\n 9,\n 10\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 200,\n \"data\": {\n \"totalClients\": 294,\n \"totalClientsSMS\": 283,\n \"totalClientsEmail\": 270\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "90b9dac4-63bd-4c5f-958d-7678a4b426a1", "name": "Exportación", "description": { "content": "Descargas CSV de clientes y audiencias.", "type": "text/plain" }, "item": [ { "id": "5528d564-73d4-4303-9375-eb5e8280041c", "name": "Crear una nueva descarga", "request": { "name": "Crear una nueva descarga", "description": {}, "url": { "path": [ "v1", "crm", "api", "exports", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idExportType\": \"\",\n \"commerceId\": \"\",\n \"uidCms\": \"\",\n \"fileName\": \"\",\n \"filters\": [\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "634edbb4-d176-4cb7-b4c8-d7db61574c10", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "exports", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idExportType\": \"\",\n \"commerceId\": \"\",\n \"uidCms\": \"\",\n \"fileName\": \"\",\n \"filters\": [\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"string\",\n \"createdBy\": \"string\",\n \"status\": \"string\",\n \"retentionTime\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26673116-bfca-4e51-970c-08e43dd1e6f0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "exports", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idExportType\": \"\",\n \"commerceId\": \"\",\n \"uidCms\": \"\",\n \"fileName\": \"\",\n \"filters\": [\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 1391,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "534e7ce1-4d5f-42c0-9a0e-41e8dda6cf30", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "exports", "new" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idExportType\": \"\",\n \"commerceId\": \"\",\n \"uidCms\": \"\",\n \"fileName\": \"\",\n \"filters\": [\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"items\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 1391,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da1798be-f6fd-4029-89e3-c8b64f00505c", "name": "Obtener la lista de descargas vigentes para un comercio", "request": { "name": "Obtener la lista de descargas vigentes para un comercio", "description": {}, "url": { "path": [ "v1", "crm", "api", "exports", "commerce", ":commerce_id", "type", ":export_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) Identificador del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "export_type", "description": "(Required) Tipo de exportacion" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "06b6c681-17cd-4bd0-8965-391599030a39", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "exports", "commerce", ":commerce_id", "type", ":export_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) Identificador del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "export_type", "description": "(Required) Tipo de exportacion" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 9023,\n \"message\": \"string\",\n \"data\": [\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"string\",\n \"createdBy\": \"string\",\n \"status\": \"string\",\n \"retentionTime\": \"string\"\n },\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"string\",\n \"createdBy\": \"string\",\n \"status\": \"string\",\n \"retentionTime\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af430dd3-cf59-49b4-81bc-d6306a1b58bd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "exports", "commerce", ":commerce_id", "type", ":export_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) Identificador del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "export_type", "description": "(Required) Tipo de exportacion" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 1391,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "883dee52-8d22-408a-a968-3bf63d95acd9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "exports", "commerce", ":commerce_id", "type", ":export_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "commerce_id", "description": "(Required) Identificador del comercio" }, { "disabled": false, "type": "any", "value": "", "key": "export_type", "description": "(Required) Tipo de exportacion" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 1391,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://apiqa.leal.co", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "commerceId", "value": "", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "info": { "_postman_id": "54860ba4-9d44-4cc1-a71f-8ebcbe002a91", "name": "API de CDP — Leal", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Superficie del módulo CDP (clientes, audiencias y exportación) que un comercio puede llamar con su token.\nAutenticación: Bearer del comercio en el header `Authorization`.\n", "type": "text/plain" } } }