A continuación encontrarás la documentación de la API de Conectamos. Esta documentación describe los endpoints disponibles y cómo interactuar con ellos. Ten en cuenta que, para ciertos servicios, se puede utilizar JWT (Bearer Token) o bien una API Key para autenticar las solicitudes.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34876551","collectionId":"16b76071-095d-4882-9fb8-0e5b3138ad0a","publishedId":"2sAYXBFed9","public":true,"customColor":{"top-bar":"7B92A7","right-sidebar":"1E2722","highlight":"CBDB00"},"publishDate":"2025-02-12T22:08:47.000Z"},"item":[{"name":"Autenticación","item":[{"name":"Registrar usuario","id":"2de2611f-6118-4b18-9aea-be7ef3f2b6dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"demo@conectamos.mx\",\r\n \"name\": \"demo ctmx\",\r\n \"password\": \"password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.conectamos.mx/v1/auth/register","description":"Registra un nuevo usuario en la plataforma.
\nDescripción:
\nCrea un nuevo usuario con su correspondiente cuenta dentro del sistema.
\nDevuelve la información del usuario creado o un mensaje de error si algo falla (por ejemplo, si el correo ya existe).
\nGenera el token JWT con el cual podrás hacer solicitudes autenticadas.EndFragment
\nDescripción:
\nRetorna un objeto con el JWT si las credenciales son correctas.
\nDeberás incluir este JWT en el encabezado Authorization para los endpoints que acepten JWT.
Ejemplo: Authorization: Bearer
Genera una API Key que podrás utilizar para consumir los servicios sin necesidad de usar JWT en cada solicitud.
\nDescripción:
\nRetorna un objeto con la nueva API Key que podrás usar en lugar del token JWT.
\nEjemplo de uso posterior: Authorization:
Existen dos formas de crear envíos (waybills) en la plataforma:
\nUsando token JWT en el encabezado.
\nUsando API Key en el encabezado.
\nEn ambos casos, el endpoint y el cuerpo son los mismos, solo cambia el encabezado de autorización.
\nDescripción:
\nPermite enviar uno o varios waybills (envíos) a la vez.
\nDevuelve la información de cada envío creado (p. ej., un identificador único de cada envío).
\nDescripción:
\nTambién se pueden consultar los detalles de un envío usando ya sea el token JWT o la API Key.
\nDescripción:
\nRetorna la información detallada del envío cuyo ID coincida con {ID}.
{ID} es el identificador único del envío que se obtiene normalmente al crearlo.
Descripción:
\nBearer se usa la API Key en el encabezado.También se pueden consultar los detalles de un envío usando ya sea el token JWT o la API Key.
\nDescripción:
\nRetorna la información detallada del envío cuyo WaybillId coincida con {waybillId}.
{waybillId} es el identificador único del envío que se obtiene normalmente al crearlo y va impreso en la etiqueta.
También se pueden consultar los detalles de un envío usando ya sea el token JWT o la API Key.
\nDescripción:
\nRetorna la información detallada del envío cuyo WaybillId coincida con {referenceId}.
{referenceId} es el identificador único del envío que envia el cliente al crear un envio.
También se pueden consultar los detalles de un envío usando ya sea el token JWT
\n","urlObject":{"path":["v1","waybill",":id"],"host":["https://api-sandbox.conectamos.mx"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"e925722d-b7df-40c2-a089-856e156b8ed7","name":"Cancelar envío","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"url":{"raw":"https://api-sandbox.conectamos.mx/v1/waybill/:id","host":["https://api-sandbox.conectamos.mx"],"path":["v1","waybill",":id"],"variable":[{"key":"id","value":"","description":"conectamos system id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b63a4da0-5657-4456-8c59-1e314852991f"}],"id":"79c964ca-d7ef-4045-8856-42c4fe3e733e","_postman_id":"79c964ca-d7ef-4045-8856-42c4fe3e733e","description":""},{"name":"Recolecciones","item":[{"name":"Crear solicitud de Recolección","id":"3dbc9b93-59c7-45cc-8c7e-bda52dae2712","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TOKEN/APIKEY","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pickup_address\": {\r\n \"street\": \"Calle Insurgentes Sur 456\",\r\n \"city\": \"Ciudad de México\",\r\n \"state\": \"CDMX\",\r\n \"zipcode\": \"6600\",\r\n \"country\": \"México\",\r\n \"coordinates\": {\r\n \"lat\": 19.391003,\r\n \"lon\": -99.146096\r\n }\r\n },\r\n \"contact_person\": {\r\n \"name\": \"María López\",\r\n \"phone\": \"+525598765432\",\r\n \"email\": \"maria.lopez@example.com\"\r\n },\r\n \"scheduled_date\": \"2025-03-30\",\r\n \"time_from\": \"10:00\",\r\n \"time_to\": \"20:00\",\r\n \"shipments\": [\r\n {\r\n \"waybill_id\": \"17b39961-0bdf-4690-9f90-d5d27fa84267\",\r\n \"reference_id\": \"MX-REF-123456\",\r\n \"package_details\": {\r\n \"unitWeight\": \"KG\",\r\n \"weight\":2,\r\n \"unitLength\": \"CM\",\r\n \"length\": 50,\r\n \"width\": 50,\r\n \"height\": 10,\r\n \"content_description\": \"Electrodoméstico pequeño\",\r\n \"special_handling\": false\r\n },\r\n \"instructions\": \"Llamar antes de llegar\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.conectamos.mx/v1/waybill/pickup","description":"También se pueden consultar los detalles de un envío usando ya sea el token JWT
\nscheduled_date solo puede actualizarse si la nueva fecha es mayor o igual a la fecha actual. No se permiten fechas pasadas.
time_from y time_to deben mantenerse dentro del mismo día y no pueden superponerse con restricciones horarias previas.
time_from debe ser menor que time_to, asegurando un intervalo de tiempo válido para la recolección.
shipments)La lista de shipments solo puede ser actualizada si el Pickup está en un estado editable.
Todos los waybill_id dentro de shipments deben existir en la base de datos.
No se pueden agregar nuevos envíos a un Pickup que ya se encuentra en estado \"IN_PROGRESS\", \"COMPLETED\" o \"CANCELED\".
Si un shipment se encuentra en estado \"DELIVERED\", no puede ser modificado ni eliminado.
El cambio de estado de un shipment debe seguir un flujo lógico. No se permite regresar un shipment de \"DELIVERED\" a \"SCHEDULED\".
package_details)No se permite modificar package_details de un shipment si ya ha sido recogido.
La actualización del peso (weight_kg) o dimensiones (dimensions_cm) solo es permitida antes de la recolección.
special_handling no puede modificarse una vez que el shipment ha sido procesado para entrega.
Si se intenta actualizar un Pickup que no existe, el sistema debe retornar un error de recurso no encontrado.
\nSi el status proporcionado no es válido dentro del enum PickupStatus, se debe rechazar la solicitud.
Si waybill_id referenciado en shipments no existe en la base de datos, la solicitud debe ser rechazada.
Si time_from y time_to no cumplen con el formato o lógica esperada, la actualización debe ser rechazada.
También se pueden consultar los detalles de un envío usando ya sea el token JWT
\n","urlObject":{"path":["v1","waybill","pickup",":pickup_id"],"host":["https://api-sandbox.conectamos.mx"],"query":[],"variable":[{"type":"any","value":"","key":"pickup_id"}]}},"response":[{"id":"84e2d2b3-ee19-4c4f-9369-1621b3d17471","name":"Actualizar solicitud de recoleccion","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"scheduled_date\": \"2025-02-27\",\r\n \"time_from\": \"10:00\",\r\n \"time_to\": \"14:00\",\r\n \"status\": \"SCHEDULED\",\r\n \"shipments\": [\r\n {\r\n \"waybill_id\": \"5040f762-de9f-4dc9-af1f-933428e67f5c\",\r\n \"reference_id\": \"MX-REF-987654\",\r\n \"package_details\": {\r\n \"unitWeight\": \"KG\",\r\n \"weight\": 2,\r\n \"unitLength\": \"CM\",\r\n \"length\": 50,\r\n \"width\": 50,\r\n \"height\": 10,\r\n \"content_description\": \"Electrodoméstico pequeño\",\r\n \"special_handling\": false\r\n },\r\n \"instructions\": \"Entrega en recepción, no dejar con vigilante\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-sandbox.conectamos.mx/v1/waybill/pickup/:pickup_id","host":["https://api-sandbox.conectamos.mx"],"path":["v1","waybill","pickup",":pickup_id"],"variable":[{"key":"pickup_id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"success\": true,\r\n \"message\": \"\",\r\n \"data\": {\r\n \"pickup_id\": \"8da1088e-d75f-4b67-95a6-7230a943ecd1\",\r\n \"scheduled_date\": \"2025-02-27T00:00:00.000Z\",\r\n \"time_from\": \"10:00\",\r\n \"time_to\": \"14:00\",\r\n \"status\": \"SCHEDULED\",\r\n \"shipments\": [\r\n {\r\n \"waybill_id\": \"5040f762-de9f-4dc9-af1f-933428e67f5c\",\r\n \"status\": \"IN_TRANSIT\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"a1d66748-47ea-4faf-a305-cae85d43b26b"},{"name":"Cancelar solicitud de Recolección","id":"a59d457f-1c81-44e0-a91b-f3a62f7979ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pickup_address\": {\r\n \"street\": \"Calle Insurgentes Sur 456\",\r\n \"city\": \"Ciudad de México\",\r\n \"state\": \"CDMX\",\r\n \"zipcode\": \"06600\",\r\n \"country\": \"México\",\r\n \"coordinates\": {\r\n \"lat\": 19.391003,\r\n \"lon\": -99.146096\r\n }\r\n },\r\n \"contact_person\": {\r\n \"name\": \"María López\",\r\n \"phone\": \"+525598765432\",\r\n \"email\": \"maria.lopez@example.com\"\r\n },\r\n \"scheduled_date\": \"2025-03-30\",\r\n \"time_from\": \"08:00\",\r\n \"time_to\": \"12:00\",\r\n \"shipments\": [\r\n {\r\n \"waybill_id\": \"5040f762-de9f-4dc9-af1f-933428e67f5c\",\r\n \"reference_id\": \"MX-REF-123456\",\r\n \"package_details\": {\r\n \"unitWeight\": \"KG\",\r\n \"weight\": 10.2,\r\n \"unitDimensions\": \"CM\",\r\n \"dimensions\": {\r\n \"length\": 20,\r\n \"width\": 15,\r\n \"height\": 10\r\n },\r\n \"content_description\": \"Electrodoméstico pequeño\",\r\n \"special_handling\": false\r\n },\r\n \"instructions\": \"Llamar antes de llegar\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.conectamos.mx/v1/waybill/pickup/:pickup_id","description":"También se pueden consultar los detalles de un envío usando ya sea el token JWT
\n","urlObject":{"path":["v1","waybill","pickup",":pickup_id"],"host":["https://api-sandbox.conectamos.mx"],"query":[],"variable":[{"type":"any","value":"","key":"pickup_id"}]}},"response":[{"id":"b760a2d4-3437-4bc5-96ee-6f9133bf91ac","name":"Cancelar solicitud de Recolección","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pickup_address\": {\r\n \"street\": \"Calle Insurgentes Sur 456\",\r\n \"city\": \"Ciudad de México\",\r\n \"state\": \"CDMX\",\r\n \"zipcode\": \"06600\",\r\n \"country\": \"México\",\r\n \"coordinates\": {\r\n \"lat\": 19.391003,\r\n \"lon\": -99.146096\r\n }\r\n },\r\n \"contact_person\": {\r\n \"name\": \"María López\",\r\n \"phone\": \"+525598765432\",\r\n \"email\": \"maria.lopez@example.com\"\r\n },\r\n \"scheduled_date\": \"2025-03-30\",\r\n \"time_from\": \"08:00\",\r\n \"time_to\": \"12:00\",\r\n \"shipments\": [\r\n {\r\n \"waybill_id\": \"5040f762-de9f-4dc9-af1f-933428e67f5c\",\r\n \"reference_id\": \"MX-REF-123456\",\r\n \"package_details\": {\r\n \"unitWeight\": \"KG\",\r\n \"weight\": 10.2,\r\n \"unitDimensions\": \"CM\",\r\n \"dimensions\": {\r\n \"length\": 20,\r\n \"width\": 15,\r\n \"height\": 10\r\n },\r\n \"content_description\": \"Electrodoméstico pequeño\",\r\n \"special_handling\": false\r\n },\r\n \"instructions\": \"Llamar antes de llegar\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-sandbox.conectamos.mx/v1/waybill/pickup/:pickup_id","host":["https://api-sandbox.conectamos.mx"],"path":["v1","waybill","pickup",":pickup_id"],"variable":[{"key":"pickup_id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"success\": true,\r\n \"message\": \"\",\r\n \"data\": {\r\n \"message\": \"Pickup fd46cdb5-2c74-4c62-9702-b80dbbb3368d has been marked as deleted\",\r\n \"pickup_id\": \"fd46cdb5-2c74-4c62-9702-b80dbbb3368d\",\r\n \"deleted_at\": \"2025-02-25T13:36:59.135Z\"\r\n }\r\n}"}],"_postman_id":"a59d457f-1c81-44e0-a91b-f3a62f7979ae"},{"name":"Consultar todas las solicitudes de recoleccion","id":"02b81d38-0953-423a-85c5-446d2b44bac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"url":"https://api-sandbox.conectamos.mx/v1/waybill/pickups","description":"También se pueden consultar los detalles de un envío usando ya sea el token JWT
\n","urlObject":{"path":["v1","waybill","pickups"],"host":["https://api-sandbox.conectamos.mx"],"query":[],"variable":[]}},"response":[{"id":"039af1da-6a38-4914-b2cc-916e0d560e49","name":"Consultar todas las solicitudes de recoleccion","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"url":"https://api-sandbox.conectamos.mx/v1/waybill/pickups"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"success\": true,\r\n \"message\": \"\",\r\n \"data\": {\r\n \"total\": 1,\r\n \"pickups\": [\r\n {\r\n \"pickup_id\": \"8da1088e-d75f-4b67-95a6-7230a943ecd1\",\r\n \"scheduled_date\": \"2025-02-27T00:00:00.000Z\",\r\n \"time_from\": \"10:00\",\r\n \"time_to\": \"14:00\",\r\n \"status\": \"SCHEDULED\",\r\n \"client_id\": \"1405f1c4-8192-4e19-b2c7-0969329a88e2\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"02b81d38-0953-423a-85c5-446d2b44bac6"},{"name":"Consultar una solicitud de recoleccion","id":"df3f3e41-29dd-41dd-a759-bfed5fb2f84f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"TOKEN/APIKEY","type":"text"}],"url":"https://api-sandbox.conectamos.mx/v1/waybill/pickup/:pickup_id","description":"También se pueden consultar los detalles de un envío usando ya sea el token JWT
\n","urlObject":{"path":["v1","waybill","pickup",":pickup_id"],"host":["https://api-sandbox.conectamos.mx"],"query":[],"variable":[{"type":"any","value":"","key":"pickup_id"}]}},"response":[{"id":"33016787-ebd2-41d7-9415-7dcaaca4041e","name":"Consultar una solicitud de recoleccion","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer :TOKEN","type":"text"}],"url":{"raw":"https://api-sandbox.conectamos.mx/v1/waybill/pickup/:pickup_id","host":["https://api-sandbox.conectamos.mx"],"path":["v1","waybill","pickup",":pickup_id"],"variable":[{"key":"pickup_id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"success\": true,\r\n \"message\": \"\",\r\n \"data\": {\r\n \"id\": \"8da1088e-d75f-4b67-95a6-7230a943ecd1\",\r\n \"client_id\": \"1405f1c4-8192-4e19-b2c7-0969329a88e2\",\r\n \"pickup_point_id\": null,\r\n \"pickup_address\": {\r\n \"city\": \"Ciudad de México\",\r\n \"state\": \"CDMX\",\r\n \"street\": \"Calle Insurgentes Sur 456\",\r\n \"country\": \"México\",\r\n \"zipcode\": \"06600\",\r\n \"coordinates\": {\r\n \"lat\": 19.391003,\r\n \"lon\": -99.146096\r\n }\r\n },\r\n \"contact_person\": {\r\n \"name\": \"María López\",\r\n \"email\": \"maria.lopez@example.com\",\r\n \"phone\": \"+525598765432\"\r\n },\r\n \"status\": \"SCHEDULED\",\r\n \"time_from\": \"10:00\",\r\n \"time_to\": \"14:00\",\r\n \"scheduled_date\": \"2025-02-27T00:00:00.000Z\",\r\n \"created_at\": \"2025-02-25T14:10:45.168Z\",\r\n \"updated_at\": \"2025-02-25T14:12:01.016Z\",\r\n \"deleted_at\": null,\r\n \"shipments\": [\r\n {\r\n \"id\": \"cef40ada-f184-4031-9d5d-88c2c23dbebe\",\r\n \"pickup_id\": \"8da1088e-d75f-4b67-95a6-7230a943ecd1\",\r\n \"waybill_id\": \"5040f762-de9f-4dc9-af1f-933428e67f5c\",\r\n \"reference_id\": \"MX-REF-987654\",\r\n \"package_details\": {\r\n \"weight_kg\": 8.5,\r\n \"dimensions_cm\": {\r\n \"width\": 40,\r\n \"height\": 25,\r\n \"length\": 50\r\n },\r\n \"special_handling\": true,\r\n \"content_description\": \"Ropa y accesorios\"\r\n },\r\n \"instructions\": \"Entrega en recepción, no dejar con vigilante\",\r\n \"status\": \"IN_TRANSIT\",\r\n \"created_at\": \"2025-02-25T14:10:45.168Z\",\r\n \"updated_at\": \"2025-02-25T14:12:01.016Z\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"df3f3e41-29dd-41dd-a759-bfed5fb2f84f"}],"id":"cfe8441e-7732-4edf-982d-56fb43957d66","_postman_id":"cfe8441e-7732-4edf-982d-56fb43957d66","description":""},{"name":"Webhooks","item":[{"name":"Listar webhooks","id":"81397c26-d22a-49d4-a4c2-8143de05608e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"81397c26-d22a-49d4-a4c2-8143de05608e"}],"id":"dc025dcd-5bc8-4eb4-8dd1-3b9b751fda15","_postman_id":"dc025dcd-5bc8-4eb4-8dd1-3b9b751fda15","description":""}],"event":[{"listen":"prerequest","script":{"id":"e8debb71-48d4-478c-9ec7-55c14b92397a","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d88712fc-3ecf-4277-9466-10091f25f68a","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"apiUrl","value":"https://api-sandbox.conectamos.mx","type":"string"}]}