{ "item": [ { "id": "5e7d2c9e-e758-4cc4-9b58-cbe2f95a45fc", "name": "Catálogos", "description": { "content": "Países", "type": "text/plain" }, "item": [ { "id": "daa59dc9-31d2-4e94-83be-9f8a44598d15", "name": "get Countries", "request": { "name": "get Countries", "description": { "content": "Obtiene los paises \n\n- Puede hacer filto por código de país o por nombre, estos se pasan en los query params\n", "type": "text/plain" }, "url": { "path": [ "v1", "api", "cnf", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "countryCode", "value": "", "description": "código del país" }, { "disabled": false, "key": "name", "value": "", "description": "nombre del país" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "3220ceef-5ed4-44cd-8937-25a4507f66bf", "name": "configuracion de bono por id de comercio", "originalRequest": { "url": { "path": [ "v1", "api", "cnf", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countryCode", "value": "CO" }, { "key": "name", "value": "Colombia" } ], "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 \"value\": \"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcc8f0ee-f463-4f43-ac14-12a37ca4b670", "name": "Error buscando la configuracion", "originalRequest": { "url": { "path": [ "v1", "api", "cnf", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "countryCode", "value": "CO" }, { "key": "name", "value": "Colombia" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca78a5b9-22f6-41ed-81a5-a97f15d0bdbe", "name": "get Cities By Country", "request": { "name": "get Cities By Country", "description": { "content": "Obtiene las ciudades de un país\n\ntiene filtro por nombre de la ciudad\n", "type": "text/plain" }, "url": { "path": [ "v1", "api", "cnf", "cities", ":countryCode" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "name", "value": "", "description": "nombre de la cudad" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "countryCode", "description": "(Required) código del país" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "fd376c83-6bbb-4873-b2b0-44251e29171c", "name": "configuracion de bono por id de comercio", "originalRequest": { "url": { "path": [ "v1", "api", "cnf", "cities", ":countryCode" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "name", "value": "Medellín" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "countryCode", "description": "(Required) código del país" } ] }, "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 \"value\": \"", "key": "countryCode", "description": "(Required) código del país" } ] }, "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": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "643433c7-aefe-4d96-b2d1-806db6bc5cac", "name": "Error buscando la configuracion", "originalRequest": { "url": { "path": [ "v1", "api", "cnf", "cities", ":countryCode" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "name", "value": "Medellín" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "countryCode", "description": "(Required) código del país" } ] }, "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": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "893174af-e153-4b7c-81ea-57a41c9c745e", "name": "get Document Type", "request": { "name": "get Document Type", "description": { "content": "Obtiene la moneda de un país", "type": "text/plain" }, "url": { "path": [ "v1", "api", "cnf", "document-type", ":countryCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "countryCode", "description": "(Required) código del país" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "52011c47-22af-4ce6-98ce-94f8adba23e8", "name": "configuracion de bono por id de comercio", "originalRequest": { "url": { "path": [ "v1", "api", "cnf", "document-type", ":countryCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "countryCode", "description": "(Required) código del país" } ] }, "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 \"value\": \"", "key": "countryCode", "description": "(Required) código del país" } ] }, "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": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7f42517-903d-4c1c-bf13-370839337045", "name": "Error buscando la configuracion", "originalRequest": { "url": { "path": [ "v1", "api", "cnf", "document-type", ":countryCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "countryCode", "description": "(Required) código del país" } ] }, "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": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0da694d0-1d2a-466f-a887-17fa1eea2774", "name": "Registro", "description": { "content": "Alta de un usuario en el comercio.", "type": "text/plain" }, "item": [ { "id": "2b0a3e87-2797-48c2-8c15-928dbc81549e", "name": "registro Unificado", "request": { "name": "registro Unificado", "description": { "content": "Registro unificado de usuarios\n\nAlta de un usuario. El path del servicio es /v2/usuarios/identidad/registro.", "type": "text/plain" }, "url": { "path": [ "v2", "usuarios", "identidad", "registro" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"codPais\": \"\",\n \"codCiudad\": \"\",\n \"plataformaOrigen\": \"\",\n \"tipoDocumento\": \"\",\n \"cedula\": \"\",\n \"celular\": \"\",\n \"nombre\": \"\",\n \"apellido\": \"\",\n \"email\": \"\",\n \"idComercio\": \"\",\n \"idSucursalRegistro\": \"\",\n \"uid\": \"\",\n \"deviceId\": \"\",\n \"genero\": \"\",\n \"cumpleanos\": \"\",\n \"tipoCuenta\": \"\",\n \"plataformaMovil\": \"\",\n \"uidCms\": \"\",\n \"ipCajero\": \"\",\n \"referenciaOrigen\": \"\",\n \"referenciaOrigenMarketing\": \"\",\n \"whiteLabel\": \"\",\n \"cuarentena\": \"\",\n \"idEstadoUbicacion\": \"\",\n \"esComercioWhiteLabel\": \"\",\n \"contrasena\": \"\",\n \"nota\": \"\",\n \"siglas\": \"\",\n \"token\": \"\",\n \"registeredDeviceLimit\": \"\",\n \"codigoTarjeta\": \"\",\n \"tipoRegistro\": \"\",\n \"pin\": \"\",\n \"channelValidation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d5099f5c-1cce-464d-ae33-a1e994fc83c9", "name": "Usuario registrado", "originalRequest": { "url": { "path": [ "v2", "usuarios", "identidad", "registro" ], "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 \"codPais\": \"CO\",\n \"codCiudad\": \"1\",\n \"plataformaOrigen\": \"API\",\n \"tipoDocumento\": 1,\n \"cedula\": \"\",\n \"celular\": \"\",\n \"nombre\": \"\",\n \"apellido\": \"\",\n \"email\": \"\",\n \"idComercio\": \"\",\n \"idSucursalRegistro\": \"\",\n \"uid\": \"\",\n \"deviceId\": \"\",\n \"genero\": \"\",\n \"cumpleanos\": \"\",\n \"tipoCuenta\": \"\",\n \"plataformaMovil\": \"\",\n \"uidCms\": \"\",\n \"ipCajero\": \"\",\n \"referenciaOrigen\": \"\",\n \"referenciaOrigenMarketing\": \"\",\n \"whiteLabel\": \"\",\n \"cuarentena\": \"\",\n \"idEstadoUbicacion\": \"\",\n \"esComercioWhiteLabel\": \"\",\n \"contrasena\": \"\",\n \"nota\": \"\",\n \"siglas\": \"\",\n \"token\": \"\",\n \"registeredDeviceLimit\": \"\",\n \"codigoTarjeta\": \"\",\n \"tipoRegistro\": \"\",\n \"pin\": \"\",\n \"channelValidation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"data\": {\n \"uid\": \"string\",\n \"token\": \"string\",\n \"refreshToken\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3152b3e3-7c75-458f-bf83-b1da9176f9d5", "name": "Validación rechazada o el usuario ya existe", "originalRequest": { "url": { "path": [ "v2", "usuarios", "identidad", "registro" ], "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 \"codPais\": \"CO\",\n \"codCiudad\": \"1\",\n \"plataformaOrigen\": \"API\",\n \"tipoDocumento\": 1,\n \"cedula\": \"\",\n \"celular\": \"\",\n \"nombre\": \"\",\n \"apellido\": \"\",\n \"email\": \"\",\n \"idComercio\": \"\",\n \"idSucursalRegistro\": \"\",\n \"uid\": \"\",\n \"deviceId\": \"\",\n \"genero\": \"\",\n \"cumpleanos\": \"\",\n \"tipoCuenta\": \"\",\n \"plataformaMovil\": \"\",\n \"uidCms\": \"\",\n \"ipCajero\": \"\",\n \"referenciaOrigen\": \"\",\n \"referenciaOrigenMarketing\": \"\",\n \"whiteLabel\": \"\",\n \"cuarentena\": \"\",\n \"idEstadoUbicacion\": \"\",\n \"esComercioWhiteLabel\": \"\",\n \"contrasena\": \"\",\n \"nota\": \"\",\n \"siglas\": \"\",\n \"token\": \"\",\n \"registeredDeviceLimit\": \"\",\n \"codigoTarjeta\": \"\",\n \"tipoRegistro\": \"\",\n \"pin\": \"\",\n \"channelValidation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 200,\n \"message\": \"Ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32da697e-47b3-4905-a205-afc71651a634", "name": "channelValidation no es SMS, EMAIL ni WSP", "originalRequest": { "url": { "path": [ "v2", "usuarios", "identidad", "registro" ], "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 \"codPais\": \"CO\",\n \"codCiudad\": \"1\",\n \"plataformaOrigen\": \"API\",\n \"tipoDocumento\": 1,\n \"cedula\": \"\",\n \"celular\": \"\",\n \"nombre\": \"\",\n \"apellido\": \"\",\n \"email\": \"\",\n \"idComercio\": \"\",\n \"idSucursalRegistro\": \"\",\n \"uid\": \"\",\n \"deviceId\": \"\",\n \"genero\": \"\",\n \"cumpleanos\": \"\",\n \"tipoCuenta\": \"\",\n \"plataformaMovil\": \"\",\n \"uidCms\": \"\",\n \"ipCajero\": \"\",\n \"referenciaOrigen\": \"\",\n \"referenciaOrigenMarketing\": \"\",\n \"whiteLabel\": \"\",\n \"cuarentena\": \"\",\n \"idEstadoUbicacion\": \"\",\n \"esComercioWhiteLabel\": \"\",\n \"contrasena\": \"\",\n \"nota\": \"\",\n \"siglas\": \"\",\n \"token\": \"\",\n \"registeredDeviceLimit\": \"\",\n \"codigoTarjeta\": \"\",\n \"tipoRegistro\": \"\",\n \"pin\": \"\",\n \"channelValidation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3273,\n \"message\": \"string\",\n \"data\": {\n \"msg\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c3a1374-410b-4f98-9959-182ee9f0c853", "name": "Error interno", "originalRequest": { "url": { "path": [ "v2", "usuarios", "identidad", "registro" ], "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 \"codPais\": \"CO\",\n \"codCiudad\": \"1\",\n \"plataformaOrigen\": \"API\",\n \"tipoDocumento\": 1,\n \"cedula\": \"\",\n \"celular\": \"\",\n \"nombre\": \"\",\n \"apellido\": \"\",\n \"email\": \"\",\n \"idComercio\": \"\",\n \"idSucursalRegistro\": \"\",\n \"uid\": \"\",\n \"deviceId\": \"\",\n \"genero\": \"\",\n \"cumpleanos\": \"\",\n \"tipoCuenta\": \"\",\n \"plataformaMovil\": \"\",\n \"uidCms\": \"\",\n \"ipCajero\": \"\",\n \"referenciaOrigen\": \"\",\n \"referenciaOrigenMarketing\": \"\",\n \"whiteLabel\": \"\",\n \"cuarentena\": \"\",\n \"idEstadoUbicacion\": \"\",\n \"esComercioWhiteLabel\": \"\",\n \"contrasena\": \"\",\n \"nota\": \"\",\n \"siglas\": \"\",\n \"token\": \"\",\n \"registeredDeviceLimit\": \"\",\n \"codigoTarjeta\": \"\",\n \"tipoRegistro\": \"\",\n \"pin\": \"\",\n \"channelValidation\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 3273,\n \"message\": \"string\",\n \"data\": {\n \"msg\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7b5ccfa6-96b5-44f9-a5a0-961e99ddd381", "name": "Sucursales", "description": { "content": "Sucursales del comercio.", "type": "text/plain" }, "item": [ { "id": "3a661618-e4c4-422f-9f9d-4ee6e98f9f92", "name": "get Branches By Commerce360", "request": { "name": "get Branches By Commerce360", "description": { "content": "Servicio para obtener la información detallada de una sucursal específica de un comercio.", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "configuration", "v1", "commerce", ":commerce_id", "branches" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "uid_cms", "value": "", "description": "(Required) ID único del usuario en CMS." }, { "disabled": false, "key": "word", "value": "", "description": "filtro del nombre de la sucursal" }, { "disabled": false, "key": "franchise", "value": "", "description": "filtro de franquisia" } ], "variable": [ { "disabled": false, "type": "any", "value": "{{commerceId}}", "key": "commerce_id", "description": "(Required) ID del comercio." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f4b7d76b-c639-44bc-8455-3eec792d9117", "name": "Información de la sucursal obtenida exitosamente.", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "configuration", "v1", "commerce", ":commerce_id", "branches" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "uid_cms", "value": "" }, { "key": "word", "value": "" }, { "key": "franchise", "value": "" } ], "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"ok\",\n \"data\": {\n \"address\": \"Av. 68 #75A - 50\",\n \"branch_id\": 55172,\n \"city_id\": 1,\n \"commerce_id\": 3,\n \"cod_pais\": \"CO\",\n \"credibanco_code\": \"00016231185\",\n \"email\": \"email@email1.com\",\n \"external_id\": \"\",\n \"franchise_id\": 0,\n \"is_virtual_branch\": false,\n \"latitude\": 4.680574955013558,\n \"longitude\": -74.08218520546262,\n \"name\": \"Sucursal Centro\",\n \"phone_number\": \"0313778669\",\n \"created_at\": \"2024-11-19 15:00:07\",\n \"schedule\": {\n \"monday\": \"always_open\",\n \"tuesday\": \"08:00:00-17:00:00\",\n \"wednesday\": \"08:00:00-17:00:00\",\n \"thursday\": \"08:00:00-17:00:00\",\n \"friday\": \"08:00:00-17:00:00\",\n \"saturday\": \"10:00:00-14:00:00\",\n \"sunday\": \"close\"\n },\n \"status\": \"activa\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e394d4ec-6ed0-4f48-a51d-cba56fd22505", "name": "No autorizado. Token no válido o ausente.", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "configuration", "v1", "commerce", ":commerce_id", "branches" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "uid_cms", "value": "" }, { "key": "word", "value": "" }, { "key": "franchise", "value": "" } ], "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": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23a25808-67ae-4672-afbb-30fd525201dc", "name": "Comercio o sucursal no encontrados.", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "configuration", "v1", "commerce", ":commerce_id", "branches" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "uid_cms", "value": "" }, { "key": "word", "value": "" }, { "key": "franchise", "value": "" } ], "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": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"datos incorrectos\",\n \"data\": {\n \"code\": \"invalidData\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a532ecf-d38f-4fee-9be5-6162a629d0fb", "name": "Error interno del servidor.", "originalRequest": { "url": { "path": [ "v1", "crm", "api", "configuration", "v1", "commerce", ":commerce_id", "branches" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "uid_cms", "value": "" }, { "key": "word", "value": "" }, { "key": "franchise", "value": "" } ], "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": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"message\": \"datos incorrectos\",\n \"data\": {\n \"code\": \"invalidData\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "951b0e84-d833-45a8-9926-855237054d86", "name": "Consulta", "description": { "content": "Búsqueda y perfil del usuario.", "type": "text/plain" }, "item": [ { "id": "40d567d7-5d36-455e-80c2-ec6964f2b6ea", "name": "consultar Usuario Criterio", "request": { "name": "consultar Usuario Criterio", "description": { "content": "Busca un usuario por criterio\n\nBusca un usuario. Con `criterio` `tipo+doc`, `valor` se parte por `#`.\nSi hay usuario, `code` es 100 y la respuesta trae `uid`.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "legacy", "consultar-usuario-criterio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"criterio\": \"\",\n \"valor\": \"\",\n \"complemento\": \"\",\n \"valorComplemento\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2690d6f6-c636-45bd-8994-058750344cc3", "name": "Usuario encontrado o no encontrado (`code` 103)", "originalRequest": { "url": { "path": [ "v1", "users", "legacy", "consultar-usuario-criterio" ], "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 \"criterio\": \"\",\n \"valor\": \"\",\n \"complemento\": \"\",\n \"valorComplemento\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1805,\n \"message\": \"string\",\n \"uid\": \"string\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7265bbd6-e226-4c35-bc48-b218690ab423", "name": "perfil Usuario", "request": { "name": "perfil Usuario", "description": { "content": "Obtiene el perfil del usuario\n\nDevuelve el perfil del `uid` de la ruta. `code` 100 y `data` con los datos del usuario.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "legacy", ":uid", "perfil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "fd462f88-31bf-44bf-891e-4e1f8f278908", "name": "Perfil del usuario", "originalRequest": { "url": { "path": [ "v1", "users", "legacy", ":uid", "perfil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uid", "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 \"code\": 1805,\n \"message\": \"string\",\n \"uid\": \"string\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "386592d6-3764-4398-b93e-5728e43b34b8", "name": "Asociación", "description": { "content": "Alta y baja del usuario en el comercio.", "type": "text/plain" }, "item": [ { "id": "d548599c-2382-44e6-8ffc-83b03f63c344", "name": "agregar Favorito", "request": { "name": "agregar Favorito", "description": { "content": "Asocia el usuario al comercio\n\nAsocia el usuario al comercio. `uid` e `idComercio` son obligatorios.\n`code` 100 devuelve `data.user_status`, `data.welcome_points` y `data.accum_point`.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "legacy", "favorite", "add" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"idComercio\": \"\",\n \"send_welcome_email\": \"\",\n \"origin_reference\": \"\",\n \"origin_reference_marketing\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11896b7e-4039-42c2-985b-ece97c321396", "name": "Asociación aplicada", "originalRequest": { "url": { "path": [ "v1", "users", "legacy", "favorite", "add" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"idComercio\": \"\",\n \"send_welcome_email\": \"\",\n \"origin_reference\": \"\",\n \"origin_reference_marketing\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1805,\n \"message\": \"string\",\n \"uid\": \"string\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ec0b467-a727-4299-9150-7f31e61ae030", "name": "quitar Favorito", "request": { "name": "quitar Favorito", "description": { "content": "Quita al usuario del comercio\n\nQuita al usuario del comercio. `uid` y `commerce_id` son obligatorios.\n`code` 100 devuelve `data.user_status`.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "legacy", "favorite", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"commerce_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26ee973d-5c10-4170-b2a7-251004c2545a", "name": "Asociación retirada", "originalRequest": { "url": { "path": [ "v1", "users", "legacy", "favorite", "remove" ], "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": "PUT", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"commerce_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1805,\n \"message\": \"string\",\n \"uid\": \"string\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ca51312a-0d00-40f7-b2b1-2e546d88ebf1", "name": "Credencial", "description": { "content": "Comercio autenticado.", "type": "text/plain" }, "item": [ { "id": "1b5aa740-3611-4b42-a49f-ec434e94dc55", "name": "public Whoami", "request": { "name": "public Whoami", "description": { "content": "Resolve AuthContext tenancy", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "public", "whoami" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "api_version", "value": "", "description": "Versión de la API. Úsala si no envías el header X-API-Version. Si van los dos, manda el header." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "d85eb693-b9fb-4373-9e10-9ef0fc90d6a6", "name": "Auth context", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "whoami" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commerce_id\": 630,\n \"credential_id\": \"11111111-1111-1111-1111-111111111111\",\n \"actor_kind\": \"commerce\",\n \"export_detail\": \"cleartext\",\n \"api_version\": \"1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ffc8fa3-2edb-40d8-9112-56f6998ebb0e", "name": "Problem details", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "whoami" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "56cc29d7-1b13-4e61-ae12-d5ea1257658c", "name": "Saldo", "description": { "content": "Saldo y movimientos del miembro.", "type": "text/plain" }, "item": [ { "id": "6396a7b5-5fc5-42e0-b095-243e28359f21", "name": "public Get Balances", "request": { "name": "public Get Balances", "description": { "content": "Get member active and pending balances", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "public", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "api_version", "value": "", "description": "Versión de la API. Úsala si no envías el header X-API-Version. Si van los dos, manda el header." }, { "disabled": false, "key": "member_ref", "value": "", "description": "(Required) " }, { "disabled": false, "key": "commerce_id", "value": "", "description": "Optional; when present must match AuthContext tenant" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "dcde20c4-5921-46c7-9a5d-84d066210e7d", "name": "Balance snapshot (zeros when empty — A-8)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commerce_id\": 630,\n \"member_ref\": \"member-demo-001\",\n \"active_balance\": 0,\n \"pending_balances\": [],\n \"as_of\": \"2026-09-28T15:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecbed567-c97b-4d4a-981d-59f565a940e8", "name": "Problem details", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "004093ec-061d-4e35-9a40-cd8b4e224652", "name": "Tenant mismatch", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14d041e1-cd8b-4dc6-b7aa-3eb65248b6ed", "name": "Commerce not migrated / business state", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2db92d06-de42-403a-917d-f6a6fa1a8ee4", "name": "public List Movements", "request": { "name": "public List Movements", "description": { "content": "List member ledger movements", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "public", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "api_version", "value": "", "description": "Versión de la API. Úsala si no envías el header X-API-Version. Si van los dos, manda el header." }, { "disabled": false, "key": "member_ref", "value": "", "description": "(Required) " }, { "disabled": false, "key": "from", "value": "" }, { "disabled": false, "key": "to", "value": "" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "cursor", "value": "" }, { "disabled": false, "key": "commerce_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "26e7e849-9415-454f-a4cc-fbcc043cf899", "name": "Movement page (empty items when none)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "page_size", "value": "50" }, { "key": "cursor", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"entry_id\": \"6983899a-093b-6fc4-1e68-96475aa8dd5d\",\n \"transaction_type\": \"string\",\n \"amount\": 5569,\n \"created_at\": \"1952-04-06T18:36:01.408Z\",\n \"member_ref\": \"string\",\n \"multiplier_factor\": 9910.19886108309,\n \"multiplier_applied\": true,\n \"non_delivery_reason\": \"string\",\n \"ceiling_applied\": false,\n \"clipped_amount\": 9270\n },\n {\n \"entry_id\": \"3fabf841-20e0-cfec-a939-58e12e75494c\",\n \"transaction_type\": \"string\",\n \"amount\": 6379,\n \"created_at\": \"2023-10-04T07:42:40.756Z\",\n \"member_ref\": \"string\",\n \"multiplier_factor\": 7583.5692402444965,\n \"multiplier_applied\": false,\n \"non_delivery_reason\": \"string\",\n \"ceiling_applied\": false,\n \"clipped_amount\": 7690\n }\n ],\n \"next_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "045e2741-b7b9-44d6-8ed4-d869f4acab54", "name": "Invalid page_size or date range (>90d)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "page_size", "value": "50" }, { "key": "cursor", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcc02ee9-64e3-4fb6-bbec-538783ed7c43", "name": "Problem details", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "page_size", "value": "50" }, { "key": "cursor", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d21711f2-6b14-4a4c-8d1f-881f563024c2", "name": "Tenant mismatch", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" }, { "key": "member_ref", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "page_size", "value": "50" }, { "key": "cursor", "value": "" }, { "key": "commerce_id", "value": "630" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3f972491-b9ac-48fa-9342-bf39942ba5d5", "name": "Acumulación", "description": { "content": "Acumulación por datos de la venta.", "type": "text/plain" }, "item": [ { "id": "a8be843f-1f10-448a-9569-9672181ea8d7", "name": "public Accumulate", "request": { "name": "public Accumulate", "description": { "content": "Public accumulation by sale facts\n\nSettles accumulation from sale facts (emit-by-rule). Tenancy comes from AuthContext.\nRequired body fields: member_ref, operation_key, external_ref, source, user_origin.\nHTTP 200 is success even when points=0 (RN-M11); see outcome.motivo_no_entrega.\nErrors use application/problem+json with HU-V2-16 families (validation, auth, conflict, business).", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "api_version", "value": "", "description": "Versión de la API. Úsala si no envías el header X-API-Version. Si van los dos, manda el header." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"\",\n \"operation_key\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"user_origin\": \"\",\n \"gross_amount\": \"\",\n \"tax_amount\": \"\",\n \"shipping_amount\": \"\",\n \"category_code\": \"\",\n \"branch_id\": \"\",\n \"occurred_at\": \"\",\n \"expiry_date\": \"\",\n \"equivalence_value\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db832d8e-096f-4126-acc7-9fb89382388e", "name": "Settled or idempotent replay (including zero-points success)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"operation_key\": \"accum-demo-001\",\n \"external_ref\": \"ticket-1001\",\n \"source\": \"pos\",\n \"user_origin\": \"pos\",\n \"gross_amount\": 50000,\n \"category_code\": \"GROCERY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operation_key\": \"accum-demo-001\",\n \"commerce_id\": 630,\n \"member_ref\": \"member-demo-001\",\n \"points\": 50,\n \"rule_id\": \"rule-default\",\n \"entry_id\": \"22222222-2222-2222-2222-222222222222\",\n \"created_at\": \"2026-09-28T15:01:00Z\",\n \"lots\": [\n {\n \"lot_id\": \"33333333-3333-3333-3333-333333333333\",\n \"amount\": 50,\n \"expiry_date\": \"2027-09-28\",\n \"status\": \"active\"\n }\n ],\n \"outcome\": {\n \"multiplier\": {\n \"applied\": false\n },\n \"ceiling_applied\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52b984ce-b977-42ac-bc75-4555fe17b883", "name": "Validation / bad request (family validation — HU-V2-16)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"operation_key\": \"accum-demo-001\",\n \"external_ref\": \"ticket-1001\",\n \"source\": \"pos\",\n \"user_origin\": \"pos\",\n \"gross_amount\": 50000,\n \"category_code\": \"GROCERY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 400,\n \"title\": \"Validation error\",\n \"detail\": \"member_ref is required\",\n \"code\": \"VALIDATION_ERROR\",\n \"family\": \"validation\",\n \"retryable\": false,\n \"catalog_version\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fd4a6ed-90b3-4bc1-a7e0-81d8a79670d5", "name": "Invalid or missing credential (family auth)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"operation_key\": \"accum-demo-001\",\n \"external_ref\": \"ticket-1001\",\n \"source\": \"pos\",\n \"user_origin\": \"pos\",\n \"gross_amount\": 50000,\n \"category_code\": \"GROCERY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "126edfb2-9bb3-4ce4-908c-ab704148911d", "name": "Tenant mismatch / not authorized (family auth)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"operation_key\": \"accum-demo-001\",\n \"external_ref\": \"ticket-1001\",\n \"source\": \"pos\",\n \"user_origin\": \"pos\",\n \"gross_amount\": 50000,\n \"category_code\": \"GROCERY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aaab600-0cac-4c3e-a814-77203e3cc995", "name": "Idempotency fingerprint conflict (family conflict)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"operation_key\": \"accum-demo-001\",\n \"external_ref\": \"ticket-1001\",\n \"source\": \"pos\",\n \"user_origin\": \"pos\",\n \"gross_amount\": 50000,\n \"category_code\": \"GROCERY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8471c447-e183-4c8f-8e8a-e5e2bbedcfe2", "name": "Business state (paused program, not migrated, …)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "accumulations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"operation_key\": \"accum-demo-001\",\n \"external_ref\": \"ticket-1001\",\n \"source\": \"pos\",\n \"user_origin\": \"pos\",\n \"gross_amount\": 50000,\n \"category_code\": \"GROCERY\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c57f517a-9f73-428c-a557-2b32e408368d", "name": "Redención", "description": { "content": "Redención de un premio del catálogo.", "type": "text/plain" }, "item": [ { "id": "007a790c-1ab7-41f5-8b52-30e6f7c3c386", "name": "public Redeem", "request": { "name": "public Redeem", "description": { "content": "Public catalog redemption\n\nRedeems a catalog reward for the authenticated commerce tenant.\nRequired body: member_ref, reward_id, operation_key, external_ref, source.", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "api_version", "value": "", "description": "Versión de la API. Úsala si no envías el header X-API-Version. Si van los dos, manda el header." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"\",\n \"reward_id\": \"\",\n \"operation_key\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"branch_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d77ddfa-3f42-4fc8-b5f0-995d5fc99ad6", "name": "Redeemed or idempotent replay", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"reward_id\": \"reward-coffee\",\n \"operation_key\": \"redeem-demo-001\",\n \"external_ref\": \"ticket-2001\",\n \"source\": \"pos\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"entry_id\": \"55555555-5555-5555-5555-555555555555\",\n \"transaction_type\": \"redeem\",\n \"commerce_id\": 630,\n \"member_ref\": \"member-demo-001\",\n \"amount\": 100,\n \"active_balance_after\": 20,\n \"lot_allocations\": [\n {\n \"lot_id\": \"33333333-3333-3333-3333-333333333333\",\n \"amount\": 100\n }\n ],\n \"operation_key\": \"redeem-demo-001\",\n \"created_at\": \"2026-09-28T15:03:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74a47ac7-bd82-4f19-9597-2ea58832d974", "name": "Validation / bad request (family validation)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"reward_id\": \"reward-coffee\",\n \"operation_key\": \"redeem-demo-001\",\n \"external_ref\": \"ticket-2001\",\n \"source\": \"pos\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e44fec-b069-47e6-839e-7bf7423e9187", "name": "Invalid or missing credential (family auth)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"reward_id\": \"reward-coffee\",\n \"operation_key\": \"redeem-demo-001\",\n \"external_ref\": \"ticket-2001\",\n \"source\": \"pos\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba1d7ca1-271d-4bed-963c-36e0204d79e6", "name": "Tenant mismatch / not authorized (family auth)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"reward_id\": \"reward-coffee\",\n \"operation_key\": \"redeem-demo-001\",\n \"external_ref\": \"ticket-2001\",\n \"source\": \"pos\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beb489f5-f515-455c-8289-4cd118da8f94", "name": "Idempotency fingerprint conflict (family conflict)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"reward_id\": \"reward-coffee\",\n \"operation_key\": \"redeem-demo-001\",\n \"external_ref\": \"ticket-2001\",\n \"source\": \"pos\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d76e465a-448e-4b06-83b5-843eddc72282", "name": "Business state / insufficient balance / archived program", "originalRequest": { "url": { "path": [ "v1", "loyalty", "public", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "api_version", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Versión de la API. Envía 1.", "key": "X-API-Version", "value": "1" }, { "disabled": false, "description": "Comercio de la operación, cuando la credencial cubre más de uno.", "key": "X-Declared-Commerce-Id", "value": "630" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member_ref\": \"member-demo-001\",\n \"reward_id\": \"reward-coffee\",\n \"operation_key\": \"redeem-demo-001\",\n \"external_ref\": \"ticket-2001\",\n \"source\": \"pos\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"status\": 2879,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"code\": \"string\",\n \"retryable\": false,\n \"family\": \"string\",\n \"catalog_version\": 8820,\n \"retry_after\": 6952\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f8ccd1fd-c509-446b-9e7d-d82bdb65b8e4", "name": "Anulación", "description": { "content": "Anulación de una acumulación o de una redención.", "type": "text/plain" }, "item": [ { "id": "1d2a6970-9f41-47d1-9cb7-ee980b4d37e3", "name": "reverse Emission", "request": { "name": "reverse Emission", "description": { "content": "Reverse an emission", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"commerce_id\": \"\",\n \"member_ref\": \"\",\n \"operation_key\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74e20633-e3cc-4660-89e7-7161f0a98349", "name": "Idempotent replay of a prior acceptance", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-reverse\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dac72f76-db5f-46cc-95b8-5c84403536a3", "name": "Accepted (first write)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-reverse\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "439fa0e9-1628-4394-af4c-5c5015ddf531", "name": "Malformed JSON / unexpected error mapping", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-reverse\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "766f6aed-ffe4-40bf-bf99-a2f5c62804f3", "name": "Origin not found or lot not reversible (`ORIGEN_NO_LOCALIZABLE`, `LOTE_NO_REVERSIBLE`)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-reverse\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec89828e-2708-4470-ae69-9f62c37c93a7", "name": "Already reversed or ambiguous external_ref (`REVERSA_YA_APLICADA`, `EXTERNAL_REF_AMBIGUOUS`)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-reverse\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b152d088-5795-41d3-aa42-33471e2666d7", "name": "Validation (missing member_ref / operation_key / origin locator)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "emissions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-reverse\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac163aec-788f-4be7-a527-6f79bc960b64", "name": "reverse Redemption", "request": { "name": "reverse Redemption", "description": { "content": "Reverse a redemption", "type": "text/plain" }, "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"commerce_id\": \"\",\n \"member_ref\": \"\",\n \"operation_key\": \"\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e4759f1a-51a2-4175-ad00-fde4204bb0ce", "name": "Idempotent replay of a prior acceptance", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-redeem-reverse\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aabc68f-9291-4ae7-8fa0-029a742f19d8", "name": "Accepted (first write)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-redeem-reverse\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2479ac85-cef0-49c0-a8e9-60e63162a059", "name": "Malformed JSON / unexpected error mapping", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-redeem-reverse\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998ab9e4-5569-443d-bb14-958334140039", "name": "Origin not found or lot not reversible", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-redeem-reverse\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb84967a-2310-4bce-8b60-cc377d8cf41f", "name": "Already reversed or ambiguous external_ref", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-redeem-reverse\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e327b85e-122d-4bc3-ae98-1353eed8c62a", "name": "Validation (missing member_ref, motive, or origin locator)", "originalRequest": { "url": { "path": [ "v1", "loyalty", "api", "points", "ledger", "redemptions", "reversals" ], "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 \"commerce_id\": 630,\n \"member_ref\": \"\",\n \"operation_key\": \"pos-ticket-778-redeem-reverse\",\n \"motive\": \"\",\n \"origin_operation_key\": \"\",\n \"origin_entry_id\": \"\",\n \"external_ref\": \"\",\n \"source\": \"\",\n \"motive_text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "86b251e5-e5f4-470d-b205-365414cc654d", "name": "Carga", "description": { "content": "Carga la factura, acumula los puntos y, si responde 100, escribe la cabecera y las líneas.", "type": "text/plain" }, "item": [ { "id": "534234db-3805-4962-92ac-45467c3626e5", "name": "cargar Factura", "request": { "name": "cargar Factura", "description": { "content": "Carga la factura y acumula los puntos\n\nCarga la factura del comercio y acumula los puntos.\nSi `code` es 100, la respuesta trae `id_transaccion` para registrar las líneas.", "type": "text/plain" }, "url": { "path": [ "v1", "integraciones", "producer", "usu_historial_puntos", "cargar_factura", ":id_comercio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id_comercio", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"idExterno\": \"\",\n \"criterio\": \"\",\n \"totalAcum\": \"\",\n \"transaccion\": {\n \"clave\": \"\",\n \"noFactura\": \"\",\n \"fecha\": \"\",\n \"fechaApertura\": \"\",\n \"fechaCierre\": \"\",\n \"totalPersonas\": \"\",\n \"formaPago\": \"\",\n \"codVendedor\": \"\",\n \"subTotal\": \"\",\n \"propina\": \"\",\n \"impuestoTotal\": \"\",\n \"descuentoTotal\": \"\",\n \"items\": [\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"cantidad\": \"\",\n \"tipoImpuesto\": \"\",\n \"precioUnidad\": \"\",\n \"precioTotal\": \"\"\n },\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"cantidad\": \"\",\n \"tipoImpuesto\": \"\",\n \"precioUnidad\": \"\",\n \"precioTotal\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a72c7e7b-0264-4204-aef6-aa57330130c9", "name": "Carga aceptada (`code` 100) o rechazada con otro `code`", "originalRequest": { "url": { "path": [ "v1", "integraciones", "producer", "usu_historial_puntos", "cargar_factura", ":id_comercio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id_comercio", "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": "POST", "body": { "mode": "raw", "raw": "{\n \"idExterno\": \"\",\n \"criterio\": \"\",\n \"totalAcum\": \"\",\n \"transaccion\": {\n \"clave\": \"\",\n \"noFactura\": \"\",\n \"fecha\": \"\",\n \"fechaApertura\": \"\",\n \"fechaCierre\": \"\",\n \"totalPersonas\": \"\",\n \"formaPago\": \"\",\n \"codVendedor\": \"\",\n \"subTotal\": \"\",\n \"propina\": \"\",\n \"impuestoTotal\": \"\",\n \"descuentoTotal\": \"\",\n \"items\": [\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"cantidad\": \"\",\n \"tipoImpuesto\": \"\",\n \"precioUnidad\": \"\",\n \"precioTotal\": \"\"\n },\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"cantidad\": \"\",\n \"tipoImpuesto\": \"\",\n \"precioUnidad\": \"\",\n \"precioTotal\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 1801,\n \"no_factura\": \"string\",\n \"id_transaccion\": 5241,\n \"puntos_activos\": 260,\n \"puntos\": 7634\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b7827ad3-161e-4f53-aef2-16e9ff2c012f", "name": "Líneas", "description": { "content": "Cabecera y líneas de la factura. Pide el id_transaccion de la carga.", "type": "text/plain" }, "item": [ { "id": "13ea0b09-5bcc-4ea9-96f9-e66cad72189f", "name": "detalles Factura", "request": { "name": "detalles Factura", "description": { "content": "Escribe la cabecera y las líneas de la factura\n\nRegistra la cabecera y las líneas de la factura. `codigoItem` es el SKU.\n`id_transaccion` es el de la carga. `code` 100 devuelve `id_factura`.", "type": "text/plain" }, "url": { "path": [ "v1", "integraciones", "producer", "com_facturas", "detalles_factura" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uid_cms\": \"\",\n \"id_sucursal\": \"\",\n \"id_transaccion\": \"\",\n \"tipo\": \"\",\n \"factura\": {\n \"totalPersonas\": \"\",\n \"noFactura\": \"\",\n \"clave\": \"\",\n \"fecha\": \"\",\n \"fechaApertura\": \"\",\n \"codVendedor\": \"\",\n \"subTotal\": \"\",\n \"impuestoTotal\": \"\",\n \"descuentoTotal\": \"\",\n \"propina\": \"\",\n \"formaPago\": \"\",\n \"items\": [\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"descripcionAdicional\": \"\",\n \"cantidad\": \"\",\n \"precioUnidad\": \"\",\n \"impuestoUnidad\": \"\",\n \"precioTotal\": \"\",\n \"tipoImpuesto\": \"\"\n },\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"descripcionAdicional\": \"\",\n \"cantidad\": \"\",\n \"precioUnidad\": \"\",\n \"impuestoUnidad\": \"\",\n \"precioTotal\": \"\",\n \"tipoImpuesto\": \"\"\n }\n ],\n \"detailedItems\": [\n {\n \"idLinea\": \"\",\n \"codModif\": \"\",\n \"numModif\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"nivel\": \"\",\n \"cantidad\": \"\"\n },\n {\n \"idLinea\": \"\",\n \"codModif\": \"\",\n \"numModif\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"nivel\": \"\",\n \"cantidad\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "624e5c34-c7ee-4a6d-adb7-4b217f0f484e", "name": "Factura escrita (`code` 100 e `id_factura`)", "originalRequest": { "url": { "path": [ "v1", "integraciones", "producer", "com_facturas", "detalles_factura" ], "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 \"uid_cms\": \"\",\n \"id_sucursal\": \"\",\n \"id_transaccion\": \"\",\n \"tipo\": \"\",\n \"factura\": {\n \"totalPersonas\": \"\",\n \"noFactura\": \"\",\n \"clave\": \"\",\n \"fecha\": \"\",\n \"fechaApertura\": \"\",\n \"codVendedor\": \"\",\n \"subTotal\": \"\",\n \"impuestoTotal\": \"\",\n \"descuentoTotal\": \"\",\n \"propina\": \"\",\n \"formaPago\": \"\",\n \"items\": [\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"descripcionAdicional\": \"\",\n \"cantidad\": \"\",\n \"precioUnidad\": \"\",\n \"impuestoUnidad\": \"\",\n \"precioTotal\": \"\",\n \"tipoImpuesto\": \"\"\n },\n {\n \"idLinea\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"descripcionAdicional\": \"\",\n \"cantidad\": \"\",\n \"precioUnidad\": \"\",\n \"impuestoUnidad\": \"\",\n \"precioTotal\": \"\",\n \"tipoImpuesto\": \"\"\n }\n ],\n \"detailedItems\": [\n {\n \"idLinea\": \"\",\n \"codModif\": \"\",\n \"numModif\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"nivel\": \"\",\n \"cantidad\": \"\"\n },\n {\n \"idLinea\": \"\",\n \"codModif\": \"\",\n \"numModif\": \"\",\n \"codigoItem\": \"\",\n \"descripcion\": \"\",\n \"nivel\": \"\",\n \"cantidad\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 9822,\n \"id_factura\": 6922\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bea5547f-51ed-4e5e-b8d7-a7fed264970a", "name": "OTP", "description": { "content": "Generar y validar el OTP.", "type": "text/plain" }, "item": [ { "id": "4fd0cc92-8cfb-4b20-90ce-8f9100d10958", "name": "Generar OTP\n\nGenera un código OTP y lo envía al usuario por el canal configurado (email, SMS, WhatsApp)", "request": { "name": "Generar OTP\n\nGenera un código OTP y lo envía al usuario por el canal configurado (email, SMS, WhatsApp)", "description": { "content": "Generar OTP\n\nGenera un código OTP y lo envía al usuario por el canal configurado (email, SMS, WhatsApp)", "type": "text/plain" }, "url": { "path": [ "v1", "otp", "otp", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cellphone\": \"\",\n \"commerceId\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"flow\": \"\",\n \"uid\": \"\",\n \"usecaseId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "266f9426-257f-4d6e-9318-ad1150c07e71", "name": "OTP generado exitosamente", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "generate" ], "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 \"cellphone\": \"\",\n \"commerceId\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"flow\": \"\",\n \"uid\": \"\",\n \"usecaseId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"currentValidationChannel\": \"string\",\n \"nextValidationChannel\": \"string\",\n \"options\": [\n \"string\",\n \"string\"\n ],\n \"otpId\": 5986\n },\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb004f55-edf1-422c-8760-a4357e36b599", "name": "Error en la solicitud", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "generate" ], "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 \"cellphone\": \"\",\n \"commerceId\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"flow\": \"\",\n \"uid\": \"\",\n \"usecaseId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2236aaa-242b-40b5-859f-d5a3eb7b329e", "name": "Error de validación", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "generate" ], "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 \"cellphone\": \"\",\n \"commerceId\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"flow\": \"\",\n \"uid\": \"\",\n \"usecaseId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f63308-e570-4030-975a-5c2469fac024", "name": "Error interno del servidor", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "generate" ], "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 \"cellphone\": \"\",\n \"commerceId\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"flow\": \"\",\n \"uid\": \"\",\n \"usecaseId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6d1f6d4-aff8-434e-a7bf-4a6de6dcb5c0", "name": "Validar OTP\n\nValida un código OTP proporcionado por el usuario", "request": { "name": "Validar OTP\n\nValida un código OTP proporcionado por el usuario", "description": { "content": "Validar OTP\n\nValida un código OTP proporcionado por el usuario", "type": "text/plain" }, "url": { "path": [ "v1", "otp", "otp", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"otpCode\": \"\",\n \"otpId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3548c312-4d52-4fec-9e3b-32f937f437a9", "name": "Validación exitosa", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "validate" ], "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 \"otpCode\": \"\",\n \"otpId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"isValid\": true,\n \"otpId\": 2220\n },\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b82b1aaf-801e-4db5-9047-948c1da57d1c", "name": "Error en la validación", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "validate" ], "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 \"otpCode\": \"\",\n \"otpId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e87e096c-06a2-48bb-8ac8-2ec77467abd6", "name": "Error de validación", "originalRequest": { "url": { "path": [ "v1", "otp", "otp", "validate" ], "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 \"otpCode\": \"\",\n \"otpId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"metadata\": \"\",\n \"success\": false,\n \"timestamp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "83d1d1df-ec84-4197-a2b1-4b99856ed38a", "name": "Perfil", "description": { "content": "Perfil de los clientes del comercio.", "type": "text/plain" }, "item": [ { "id": "4117c008-bd35-4024-9aa5-50afbab582b0", "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": { "content": "Endpoint que permite obtener el total de clientes de un comercio", "type": "text/plain" }, "url": { "path": [ "v1", "crm", "api", "clients", ":commerceId", "info", "behavioral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "772ba719-2a66-4665-96ea-b1dd0b63d94c", "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": "d810c58e-220c-4b6d-82e4-2b77d9a281b1", "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": "f677293e-37cb-42ac-986d-e296428c6520", "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": "a9bd4030-c39b-4fc7-8c94-5dfd78219029", "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": { "content": "Endpoint que permite consultar los géneros y los grupos de edades por comercio", "type": "text/plain" }, "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": "039354d3-80cf-4054-8e94-7ecff856402e", "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\": 4895,\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": "3e66e785-c35d-4686-b0ce-0b06a8a0202c", "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": "dff51a9a-72fe-4dd1-b09f-221ebe93e819", "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": "0a1b98bb-7e9c-408d-b2e5-8f03690c3b9f", "name": "Endpoint que permite consultar las estadísticas RFM por comercio", "request": { "name": "Endpoint que permite consultar las estadísticas RFM por comercio", "description": { "content": "Endpoint que permite consultar las estadísticas RFM por comercio", "type": "text/plain" }, "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": "9378049e-0290-4acd-9c48-e52dc3987e11", "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\": 48,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8caf2918-fd48-4c5a-85d0-a55d0de97024", "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": "bfc4dcf5-7222-4ee9-80ae-b3827d61a5a8", "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": "b10d9e1a-5bab-4f34-be24-d11a781cdf0b", "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": "2a025214-0367-46ef-8f44-ac4c7159c868", "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": { "content": "Endpoint que permite actualizar el estado de un cliente para un comercio", "type": "text/plain" }, "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": "4b521369-6630-43b4-9c1e-754a31395249", "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": "c535b943-3bc2-42fb-b908-4f9e3b51b76d", "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": "141f0eb1-7e58-45df-8675-9b566fc3f723", "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": "323832cf-4174-4d2e-bcc6-60254f58f9d2", "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": "9cf35f3c-b6ca-4cb3-a9c1-326d70cf0a34", "name": "Endpoint que permite obtener listado de clientes de un comercio", "request": { "name": "Endpoint que permite obtener listado de clientes de un comercio", "description": { "content": "Endpoint que permite obtener listado de clientes de un comercio", "type": "text/plain" }, "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": "1a3acf97-810f-4198-9153-d6a7a06240d0", "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": "d17085c8-8176-43a8-8433-3c92e8a7f97e", "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": "804cc947-05e5-4dde-a662-6f59600f0b38", "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": "0da8fba3-7515-42fb-848b-1254367a5c77", "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": "ac274f53-893e-40b2-9cf9-2850553cd216", "name": "Audiencias", "description": { "content": "Crear", "type": "text/plain" }, "item": [ { "id": "c592db67-8370-4516-a408-048925eac0bb", "name": "Crea una nueva audiencia (V2) - Soporta audiencias legacy (applied_filters) y groups (condition tree)\n\nEste 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", "request": { "name": "Crea una nueva audiencia (V2) - Soporta audiencias legacy (applied_filters) y groups (condition tree)\n\nEste 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", "description": { "content": "Crea una nueva audiencia (V2) - Soporta audiencias legacy (applied_filters) y groups (condition tree)\n\nEste 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", "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": "93a4b8b3-b2ec-4bad-b753-5168834f5c4f", "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": "b272bf8a-33ee-4233-8e8b-e930730baeb6", "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": "7e4270f0-b2a9-4474-8881-85628f25f860", "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": "dd10cd77-8594-40d2-bca5-f721d98db43e", "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": "5e9fda50-bb4f-4aa3-8714-69a4461c04a2", "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": "07c29a1c-91df-49fe-8179-cb137c4e71b2", "name": "Obtiene un segmento por ID (V2) — incluye árbol de condiciones y metadata de conteo\n\nRetorna 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).", "request": { "name": "Obtiene un segmento por ID (V2) — incluye árbol de condiciones y metadata de conteo\n\nRetorna 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).", "description": { "content": "Obtiene un segmento por ID (V2) — incluye árbol de condiciones y metadata de conteo\n\nRetorna 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).", "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": "8c67d4ae-f9a3-4d91-af0a-2e8ea276147b", "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": "ad1e7337-9ae8-4daf-9228-97dcbe3afae4", "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": "39775c46-ca79-4240-acbe-8e673785b2d6", "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": "cec99520-98cd-4366-a0cf-3fcabad3e864", "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": "e57090bb-35b5-44cb-bb6a-c5d513a1dc7d", "name": "Actualiza (full-replace) un segmento existente por ID (V2)\n\nEdita 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.", "request": { "name": "Actualiza (full-replace) un segmento existente por ID (V2)\n\nEdita 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.", "description": { "content": "Actualiza (full-replace) un segmento existente por ID (V2)\n\nEdita 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.", "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": "03a0ffb8-626c-46e9-a036-8690888bc81c", "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": "e3c82eec-2c5e-4348-b700-fc6b87365653", "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": "d2529059-4591-40d3-8ab1-09775ac801cd", "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": "a9a9c5ae-65ce-43c6-b5df-b2490126db54", "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": "e26aba54-d49e-4980-a052-00a452aeefd9", "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": "8ae681f6-5f9e-41e3-9798-251f470b1f80", "name": "Elimina permanentemente un segmento por ID (V2) — dual gate + hard delete atómico\n\nElimina 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).", "request": { "name": "Elimina permanentemente un segmento por ID (V2) — dual gate + hard delete atómico\n\nElimina 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).", "description": { "content": "Elimina permanentemente un segmento por ID (V2) — dual gate + hard delete atómico\n\nElimina 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).", "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": "2de86c2b-3606-4b29-a7b7-450086bbd62f", "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": "8558db93-22cb-45db-91c3-c4bbd28ac92e", "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": "eafd570c-0d30-40e1-a12d-64d637f0f096", "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": "e6a90265-09a5-4930-83b6-70cdf9c9249f", "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": "aaae353d-575b-4fcc-b9ea-aea7b532d3ec", "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": "d6965f69-6b17-4abb-90a7-ddd15326d0f2", "name": "Duplica un segmento existente en una copia independiente (V2)\n\nCrea 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).", "request": { "name": "Duplica un segmento existente en una copia independiente (V2)\n\nCrea 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).", "description": { "content": "Duplica un segmento existente en una copia independiente (V2)\n\nCrea 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).", "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": "511aa929-3b62-4163-b9a1-3c985cccfe9f", "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": "7062002c-c4cd-4644-b9f2-d0446d4a107e", "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": "dfc93f7b-1282-444b-9331-0d605d01523d", "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": "fe6277b3-a62d-4482-8601-b3577eaca4a3", "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": "9aa4fbde-bd94-46fe-bb7c-b968f512c760", "name": "Retorna todas las segmentaciones del comercio", "request": { "name": "Retorna todas las segmentaciones del comercio", "description": { "content": "Retorna todas las segmentaciones del comercio", "type": "text/plain" }, "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": "b29da400-3b86-4e1c-95dd-608310e74263", "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": "ab031604-d017-4312-8d40-3064f15c4281", "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": { "content": "Retorna el detalle de una segmentación específica del comercio", "type": "text/plain" }, "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": "32aca004-958c-454c-a2ca-880e4ac8e6d5", "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": "6deb8479-f7b7-456d-af86-9cf12cb24cef", "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": "f75c02cb-4e4a-4a4d-aa7d-c50780184052", "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": "0c49e5cd-73bd-4662-a715-77093de56944", "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": { "content": "Retorna la información de los clientes de una segmentación del comercio", "type": "text/plain" }, "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": "d30cf598-3e94-490e-9e61-3f2eb42ce852", "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": "a045d548-242c-485f-b2e4-baf6034296c1", "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": { "content": "Consulta los filtros de las segmentaciones basado en el id del comercio y clasificados por la categoria\ndel filtro", "type": "text/plain" }, "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": "0d4bb2a0-0df3-43fd-92c0-98f850f62792", "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": "6b721899-37d9-4853-bea3-2a6f431f4f74", "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": "543a702f-0cdd-4bb5-8cbe-ee5ebe6f06bf", "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": "f999a11d-2aa3-4849-a04c-a2eee86bd5f7", "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": "831eab82-241e-4354-9c44-f6c5dd0aed56", "name": "Consulta audiencias sugeridas por Leal, para luego crearlas al comercio", "request": { "name": "Consulta audiencias sugeridas por Leal, para luego crearlas al comercio", "description": { "content": "Consulta audiencias sugeridas por Leal, para luego crearlas al comercio", "type": "text/plain" }, "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": "b642425c-5985-467c-8d40-899b52c53185", "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": "3e07133f-8d18-487d-8842-b3708c2b877d", "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": "d9a2cdc8-9a9d-4d88-b1cf-4edd2602be83", "name": "Exportación", "description": { "content": "Descargas CSV de clientes y audiencias.", "type": "text/plain" }, "item": [ { "id": "cb4100a8-949d-490d-81da-bd8334c0d153", "name": "Create Export File", "request": { "name": "Create Export File", "description": { "content": "Crear una nueva descarga", "type": "text/plain" }, "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": "89054bd2-43a6-41d8-a6dd-7a55c4334a18", "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": "56132055-d58a-4c39-8c29-6bc44eac8e7b", "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\": 9832,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aaba683-b274-4515-a4a1-0b1fd2bc5b17", "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\": 9832,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fb3f8bf-9d0d-4d9b-a209-f73a3d3a8ac7", "name": "Get Export File List", "request": { "name": "Get Export File List", "description": { "content": "Obtener la lista de descargas vigentes para un comercio", "type": "text/plain" }, "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": "cd23ac82-2bf8-4218-b671-e29cf066f6e3", "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\": 2579,\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": "53c0055c-e2d0-4eaf-a1e0-e72367462a8a", "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\": 9832,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04c1c91c-ed1b-49d5-8b8b-b1ac9ec42a10", "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\": 9832,\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": "2010397c-0ebe-43ff-b016-09f02d5b0be0", "name": "APIs de integración de Leal", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Integración de un comercio con Leal.\nEl AccessToken va en `Authorization: Bearer`.\nEn Puntos, envía también `X-API-Version: 1`.\n", "type": "text/plain" } } }