{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3feeeadf-6852-4ffb-be90-a0621bfa6aab","name":"REST-API-O2O","description":"### Visión General\n\nLa API REST-API-O2O de VIVIPOST permite a los desarrolladores integrar de manera sencilla y eficiente la gestión de almacenamiento y transporte de paquetes en sus aplicaciones. Esta API expone servicios para interactuar con una red combinada de **lockers inteligentes, donde los usuarios pueden agendar compartimientos para almacenar y posteriormente transportar sus paquetes**, y **tiendas asociadas (UTC), habilitando la gestión de paquetes a través de estos puntos de servicio**.\n\n**Es importante tener en cuenta que, actualmente, los servicios de envío están segmentados. Un envío debe tener un origen y un destino del mismo tipo: o bien ambos son lockers, o bien ambos son tiendas. No se admiten envíos con origen en un locker y destino en una tienda, o viceversa.**\n\nA través de endpoints bien definidos, la API facilita las siguientes funcionalidades:\n\n- **Gestión de Puntos de Servicio:** Obtención de información y administración de lockers y tiendas (ubicación, capacidad, horarios, etc.).\n- **Consulta de Disponibilidad:** Verificación programática de la disponibilidad de compartimientos en lockers.\n- **Cálculo de Costos:** Integración del cálculo de costos de servicio para lockers y tiendas, asociados al traslado de paquetes.\n- **Generación de Referencias de Pago:** Creación automatizada de referencias de pago para los servicios de lockers y tiendas.\n- **Notificación de Pago:** Implementación de mecanismos para notificar a VIVIPOST sobre el procesamiento exitoso de pagos.\n    \n\n**Es importante destacar que los traslados de paquetes desde lockers o tiendas a su destino final son gestionados por socios carriers, y no directamente por VIVIPOST.** La API se enfoca en la gestión del almacenamiento y la generación de las referencias de pago\n\n### **Propósito**\n\nEl propósito principal de la API REST-API-O2O de VIVIPOST es proporcionar a los desarrolladores las herramientas necesarias para incorporar sin problemas las capacidades de gestión de paquetes de VIVIPOST en sus propias plataformas. Esto permite a sus usuarios finales acceder a una red de lockers inteligentes y tiendas UTC asociadas directamente desde sus aplicaciones, ofreciendo:\n\n- **Integración Fluida (con restricción de tipo de servicio):** Incorporación sencilla de la lógica de agendamiento de compartimientos en lockers (especificando origen y destino **siendo ambos lockers**) y la gestión de servicios con tiendas UTC (especificando origen y destino **siendo ambas tiendas**). Actualmente, no se admiten envíos entre lockers y tiendas.\n- **Manejo de Datos:** Facilidad para enviar y recibir información detallada de los paquetes y de los clientes (remitente y destinatario) a través de la API.\n- **Procesos de Pago Integrados:** Implementación de flujos de pago personalizados mediante la generación de referencias y la notificación del estado del pago a través de la API.\n    \n\n#### Autenticación\n\nPara garantizar la seguridad y la autenticidad de las solicitudes, VIVIPOST utiliza JWT (JSON Web Tokens) como método de autenticación en su API.\n\n#### ¿Cómo funciona?\n\nCada cliente debe incluir un token JWT válido en el encabezado de autorización (`Authorization`) de cada solicitud que realice a la API. Este token sirve para verificar la identidad del cliente que está haciendo la solicitud y asegurarse de que tiene los permisos adecuados para acceder a los recursos solicitados.\n\n#### **Formato del token:**\n\nEl token JWT debe ser enviado como un valor en el encabezado `Authorization` con el esquema `Bearer`. El formato esperado es `Bearer` , donde es el token JWT específico que VIVIPOST ha generado y proporcionado a tu aplicación.\n\n#### Obtención del Token\n\nVIVIPOST genera y proporciona el token JWT al cliente autorizado una vez que se han completado los registros y configuraciones necesarias. El cliente recibe este token bajo una documentación específica para acceder a la API. El cliente debe incluir este token en todas las solicitudes subsiguientes.\n\n#### Validación del Token\n\nCada vez que la API recibe una solicitud, el servidor valida el token JWT incluido en el encabezado de la solicitud. Si el token es válido y no ha expirado, la solicitud continúa; si no, se denegará el acceso y se devolverá un mensaje de error con el código de estado apropiado (por ejemplo, 401 Unauthorized).\n\n#### Privacidad y Acceso\n\nEsta API es privada y solo está disponible para **desarrolladores** (o aplicaciones) autorizados por VIVIPOST. El acceso se limita exclusivamente a aquellos **desarrolladores** que hayan recibido un token JWT válido por parte de VIVIPOST. El token debe mantenerse de manera confidencial para prevenir accesos no autorizados.\n\n### Versiones\n\n- **v1.0.0**: Versión inicial, Junio 2024.\n    - **Funcionalidad**: Implementación de servicios relacionados con los lockers, incluyendo la gestión de compartimientos, referencias de pago, y la consulta de paquetes permitidos.\n- **v1.1.0**: Actualización, Abril 2025.\n    - **Funcionalidad**: Incorporación de servicios asociados a las tiendas, lo que permite gestionar tiendas cercanas, calcular costos entre tiendas y generar referencias de pago para transacciones de tiendas.\n    - **Nuevas características**:\n        - Consultar tiendas cercanas.\n        - Calcular costos para el servicio entre tiendas.\n        - Crear referencias de pago asociadas a las tiendas.\n\n#### Contacto\n\nPara soporte o consultas adicionales, visita nuestra página web o contáctanos en:  \n**Página web:** [https://vivipost.com](https://vivipost.com/es/)  \n**Correo electrónico de soporte:** [contato@vivipost.com](https://null)\n\n#### Endpoints Principales\n\n- **Packages**\n    - **`GET /packages/allowed`**: Obtener paquetes permitidos.\n    - **`GET /packages/insurance`**: Obtener detalles del seguro.\n- **Lockers**\n    - **`GET /lockers/nearby`**: Obtener lockers cercanos.\n    - **`GET /lockers/{main_locker_id}/nearby`**: Obtener lockers cercanos a un locker principal (ya seleccionado).\n    - **`GET /lockers/compartments/sizes`**: Obtener tamaños de compartimientos.\n- **Users**\n    - **`GET /users/details`**: Obtener detalles del usuario.\n    - **`PUT /users/details`**: Actualizar detalles del usuario.\n    - **`GET /users/{id}/transactions`**: Obtener historial de transacciones del usuario.\n- **Service**\n    - **`GET /service/transactions/:id`**: Obtener referencias de pago por ID.\n    - **`POST /service/calculate-cost`**: Calcular el costo del servicio.\n    - **`POST /service/payment-reference`**: Crear una referencia de pago.\n    - **`DELETE /service/payment-reference/:id`**: Cancelar una referencia de pago.\n- **Stores**\n    - **`GET /stores/nearby`**: Obtener una lista de tiendas cercanas a la ubicación actual del usuario, mostrando detalles como nombre, dirección y horarios de apertura.\n    - **`GET /stores/{main_store_id}/nearby`**`:` Obtener tiendas cercanas a una tienda principal específica (utilizando el `main_store_id`).\n    - **`POST /stores/calculate-cost`**`:` Calcular el costo del servicio de traslado entre tiendas, incluyendo detalles como el valor del seguro, protección y costo por distancia.\n    - **`POST /stores/payment-reference`**`:` Crear una referencia de pago para el servicio relacionado con una tienda.\n\n#### Tabla de Errores\n\n| Código de Error | Descripción | Solución |\n| --- | --- | --- |\n| 200 | Operación exitosa. | \\- |\n| 204 | La solicitud fue exitosa, pero no hay contenido en la respuesta. | \\- |\n| 400 | Datos faltantes o incorrectos en la solicitud. | Verifica los datos enviados. |\n| 401 | No autorizado. Fallo en la autenticación de la API. | Proporciona un token JWT válido. |\n| 403 | Permiso denegado. No tiene acceso a este recurso. | Verifica los permisos del usuario. |\n| 404 | El recurso solicitado no existe. | Verifica la existencia del recurso solicitado. |\n| 409 | Conflicto en la solicitud. | Verifica los datos enviados y reintenta la solicitud. |\n| 422 | Datos inválidos en la solicitud. | Verifica el formato de los datos enviados. |\n| 500 | Error interno en el servidor. | Contacta con soporte técnico. |\n\n#### Ejemplo de Errores\n\n- **400 Datos faltantes o incorrectos en la solicitud**: Se produce cuando algunos datos necesarios no se envían o son incorrectos.\n- **401 No autorizado. Fallo en la autenticación de la API**: Ocurre cuando la autenticación con el token JWT falla o no se proporciona.\n- **404 El recurso solicitado no existe**: Se genera cuando se intenta acceder a un recurso que no está disponible.\n- **500 Error interno en el servidor**: Se produce cuando hay un problema inesperado en el servidor.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"36784299","team":6330982,"collectionId":"3feeeadf-6852-4ffb-be90-a0621bfa6aab","publishedId":"2sB2cSiQDn","public":true,"publicUrl":"https://api-o2o.vivipost.com","privateUrl":"https://go.postman.co/documentation/36784299-3feeeadf-6852-4ffb-be90-a0621bfa6aab","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"API REST para gestión de paquetes en lockers inteligentes y tiendas UTC de VIVIPOST. Permite agendar compartimientos, calcular costos y generar referencias de pago, con integración a socios carriers para transporte.  "},{"name":"title","value":"REST-API VIVIPOST O2O - Gestión de Lockers & Tiendas UTC para Paquetes"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-04-03T21:59:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"REST-API VIVIPOST O2O - Gestión de Lockers & Tiendas UTC para Paquetes","description":"API REST para gestión de paquetes en lockers inteligentes y tiendas UTC de VIVIPOST. Permite agendar compartimientos, calcular costos y generar referencias de pago, con integración a socios carriers para transporte.  "},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"SandBox","id":"008f7aec-cbe2-49f7-8930-3c8f10119e6d","owner":"36784299","values":[{"key":"base_url","value":"https://api-sandbox-oxxopost.vivipost.com/v1/o2o/","enabled":true,"type":"default"},{"key":"auth_token","value":"pordefinir","enabled":true,"type":"secret"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/12450b194f52af18a5d01a434468cec02810b14993cc48380b145b8e7d4adeda","favicon":"https://vivipost.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"SandBox","value":"36784299-008f7aec-cbe2-49f7-8930-3c8f10119e6d"}],"canonicalUrl":"https://api-o2o.vivipost.com/view/metadata/2sB2cSiQDn"}