{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d935076f-dee6-425e-a6e1-7aa3527b02fe","name":"API mipaquete.com versión 2","description":"Alcance de la API mipaquete.com  \nLa API de mipaquete.com integra todas las funcionalidades de nuestra plataforma y le permite a tu comercio electrónico o Marketplace automatizar la logística de envíos.\n\n###### **IMPORTANTE**\n\n\\* Actualización realizada el 06 de octubre 2022, se agrega la propiedad averageShipments, mas información al crear el usuario  \n\\* Completa los datos de tu perfil para garantizar que la integración funcione adecuadamente. (Si tienes tu perfil completo haz caso omiso al mensaje)\n\n¿Qué servicios contiene la API?\n\n\\* Cotizar automáticamente: Predeterminar las transportadoras con las que desea trabajar o indicar criterios de selección automática.\n\n\\* Información detalla del envío.  \n\\* Generación de la guía y url de la misma de forma automática.  \n\\* Solicitud de recogida automática a la transportadora.  \n\\* Trazabilidad de los envíos.  \n\\* Cancelar el envío.  \n\\* Listado de ciudades con código DANE  \n\\* Crear usuarios.  \n\\* Actualizar usuarios.\n\nCOTIZAR AUTOMÁTICAMENTE:  \nCotiza automáticamente el costo de los envíos con las transportadoras que tengan servicio de acuerdo con la ciudad origen – destino consultada.\n\nEn la parametrización se puede definir que:  \n• Se generen envíos con una única transportadora.  \n• El sistema seleccione automáticamente la transportadora con base en uno de los siguientes criterios: Menor precio, menor tiempo de entrega, menor tiempo de recogida y mayor calificación de servicio.\n\n• Se presentan también los precios de envíos con pago contra entrega, por si el e-commerce desea habilitar esta opción.\n\n• También permite configurar que ciertas rutas se realicen con determinadas  \ntransportadoras. Ejemplo: Cali – Bogotá con Coordinadora, Pasto – Santa Marta con Servientrega.\n\n• También se presenta el comparativo de transportadoras (con sus precios, tiempos de entrega y calificación de servicio) para que esta información se presente en el proceso de check out del e-commerce, si este así lo desea.  \nINFORMACIÓN DETALLADA DEL ENVÍO.\n\nLos siguientes datos del envío son guardados y pueden ser consultados a través de la API en cualquier momento\n\n• Producto o Referencia (descripción del producto)\n\n• Código mipaquete\n\n• Número de Guía\n\n• Número de Recolección – Código propio de recolección de la transportadora\n\n• Fecha de Solicitud\n\n• Hora de Solicitud\n\n• Fecha de Recogida\n\n• Origen\n\n• Nombre del remitente\n\n• Tipo de Identificación Remitente\n\n• Identificación del remitente\n\n• Celular del Remitente\n\n• Dirección Remitente\n\n• Destino\n\n• Destinatario\n\n• Celular del destinatario\n\n• Dirección Destinatario\n\n• Cantidad\n\n• Dimensiones(cm)\n\n• Peso Volumen (kg) - Es la fórmula que utilizan las transportadoras para calcular el valor del envío según las dimensiones y el peso real.\n\n• Peso (kg)\n\n• Peso Facturado (kg) – Peso facturado por parte de la transportadora\n\n• Servicio Adicional – Si el envío tiene servicio de pago contra entrega o no.\n\n• Valor a recaudar – Monto a cobrar por el mensajero cuando realiza la entrega del producto  \n(Aplica para servicio de pago contra entrega).\n\nLos siguientes datos a continuación son necesarios para la consignación del valor recaudado en el envío (Aplica para servicio de pago contra entrega):\n\n• Banco\n\n• Nombre del Beneficiario\n\n• Número de cuenta\n\n• Número de identificación del beneficiario\n\n• Tipo de identificación\n\n• Tipo de cuenta\n\n• Valor declarado – Valor al cuál se desea asegurar el producto en caso de pérdida o daño.\n\n• Transportadora\n\n• Valor de la Venta – Costo del producto en el proceso de venta (Aplica para servicio de pago contra entrega).\n\n• Valor del flete – Costo del envío\n\n• Valor de la comisión de recaudo – Comisión que cobra la transportadora por realizar el recaudo del producto.\n\n• Valor total del servicio – Sumatoria del costo del envío y el valor de la comisión de recaudo\n\n• Valor a Transferir – Valor a transferir en caso que se haya realizado un recaudo exitoso del producto (Aplica para servicio de pago contra entrega).\n\n• Forma de pago – Tipo de pago del envío (existen dos hasta el momento: descontando el envío del recaudo realizado o pago con saldo).\n\n• Estado actual del envío\n\n• Fecha última actualización- Fecha del estado actual del envío\n\n• Hora última actualización- Hora del estado actual del envío\n\n• Tiempo promesa de entrega en días hábiles\n\n• Observaciones del envío\n\n• Reintegro comisión del recaudo (por devolución) – Valor de reintegro de comisión de recaudo en caso de devolución del paquete.\n\n• Cobro flete devolución – Valor del costo de devolución del paquete.\n\n• Costo total del envío (ida y regreso) – En caso de devolución, sumatoria de costo de el envío ida y regreso.\n\n• Costo pendiente por cobrar – Costo pendiente en caso de tener un pago pendiente por devolución del envío.\n\n• URL del pdf de la guía o relación a imprimir.  \nGENERACIÓN DE LA GUÍA Y URL DE LA MISMA DE FORMA AUTOMÁTICA.  \nUna vez generado el envío, la API permite la consulta de la url de la guía con su respectiva relación de despacho (si aplica según la transportadora).\n\nSOLICITUD DE RECOGIDA AUTOMÁTICA A LA TRANSPORTADORA.  \nEn la parametrización de la integración el e-commerce puedes optar por habilitar o no la opción de que una vez generado el envío se genere de forma automática la recolección en la dirección del remitente.  \nLa API permite generar envíos con diferentes ciudades y direcciones de recolección, esta opción es muy útil especialmente para Marketplace, e-commerce que tengan varias bodegas de despacho o plataformas de dropshipping.  \nTRAZABILIDAD DE LOS ENVÍOS.  \nLa API permite consultar el seguimiento detallado o tracking del envío, para cualquier transportadora.\n\nEn resumen, cada vez que se genere una venta en tu tienda online, la generación de la guía y orden de despacho se realiza de forma automática. Además puedes presentar directamente en tu tienda el estado del pedido, para que tus clientes lo puedan consultar desde allí.\n\nPara la integración recibe apoyo de nuestro equipo de soporte.  \nDocumentación de la API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14212363","team":2109339,"collectionId":"d935076f-dee6-425e-a6e1-7aa3527b02fe","publishedId":"Tzm8GFfQ","public":true,"publicUrl":"https://api.documentacion.mipaquete.com","privateUrl":"https://go.postman.co/documentation/14212363-d935076f-dee6-425e-a6e1-7aa3527b02fe","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"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":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2023-08-29T23:20:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"DEV","id":"b446f5f1-e2ec-4526-91c4-d3bee4e791b8","owner":"14212363","values":[{"key":"uriOauth","value":"https://auth.dev.mpr.mipaquete.com","enabled":true},{"key":"uriSendings","value":"https://sendings.dev.mpr.mipaquete.com","enabled":true},{"key":"uriENVIA","value":"https://envia.dev.mpr.mipaquete.com","enabled":true},{"key":"uriSERV","value":"https://servientrega.dev.mpr.mipaquete.com","enabled":true},{"key":"uriTCC","value":"https://tcc.dev.mpr.mipaquete.com","enabled":true},{"key":"uriAPI","value":"https://ecommerce.dev.mpr.mipaquete.com","enabled":true},{"key":"uriNotify","value":"https://notify.dev.mpr.mipaquete.com","enabled":true},{"key":"uriApiV2","value":"https://api-v2.dev.mpr.mipaquete.com","enabled":true},{"key":"APIKEY","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2MGI0OWI2ZmMxN2NlMDM0Y2ZmZGM3YzEiLCJuYW1lIjoiUHJ1ZWJhcyIsInN1cm5hbWUiOiJtaXBhcXVldGUiLCJlbWFpbCI6InBydWViYXNtaXBhcXVldGVvZmljaWFsQGdtYWlsLmNvbSIsImNlbGxQaG9uZSI6IjMxMzYyNzMyMzciLCJjcmVhdGVkQXQiOiIyMDIxLTA1LTMxVDA4OjE2OjQ3Ljc4OFoiLCJkYXRlIjoiMjAyMi0xMC0zMCAyMDo1Mjo1NSIsInBhc3N3b3JkIjoiVGVzdG1wMTIzJCIsImlhdCI6MTY2NzE4MTE3NX0.z7kiw6yPpS1ge_0uwtXveapw54-RAE0p02-eK-HZvrY","enabled":true},{"key":"uriCash","value":"https://cash.dev.mpr.mipaquete.com","enabled":true},{"key":"apiEcommerce","value":"https://ecommerce.dev.mpr.mipaquete.com","enabled":true},{"key":"uriRoutes","value":"https://routes.dev.mpr.mipaquete.com","enabled":true},{"key":"uriCOOR","value":"https://coor.dev.mpr.mipaquete.com","enabled":true},{"key":"uriUser","value":"https://core.dev.mipaquete.com","enabled":true},{"key":"uriTEMPO","value":"https://tempoexpress.dev.mpr.mipaquete.com","enabled":true},{"key":"uriNovelties","value":"https://novelties.dev.centrodeayuda.mipaquete.com","enabled":true},{"key":"uriJUMP","value":"https://jumpseller.dev.plugins.mipaquete.com","enabled":true},{"key":"uriPluginBack","value":"https://globalback.dev.plugins.mipaquete.com","enabled":true},{"key":"uriCompanies","value":"https://dcompanies.dev.mpr.mipaquete.com","enabled":true},{"key":"uriELP","value":"https://elp.dev.mpr.mipaquete.com","enabled":true},{"key":"uriSHOPIFY","value":"https://shopify.dev.plugins.mipaquete.com","enabled":true},{"key":"uriENTREGALO","value":"https://entregalo.dev.mpr.mipaquete.com","enabled":true},{"key":"uriNegotiations","value":"https://negotiations.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"uriBilling","value":"https://billing.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"uriStatistics","value":"https://statistics.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"uriDeprisa","value":"https://deprisa.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"uriGlobalconfig","value":"https://globalconfig.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"userToken","value":"","enabled":true,"type":"any"},{"key":"uriReports","value":"https://reporting.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"uriQuoteInter","value":"https://qawww3.interrapidisimo.co/ApiVentaCreditoQA/api","enabled":true,"type":"default"},{"key":"uriGeneralInter","value":"https://qawww3.interrapidisimo.co/ApiVentaCreditoQA/api","enabled":true,"type":"default"},{"key":"uriInterrapidisimo","value":"https://interrapidisimo.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"urilnteractions","value":"https://interactions.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"urlFedex","value":"https://fedex.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"urlAndreani","value":"https://andreani.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"urlRedpack","value":"https://redpack.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"urlUrbano","value":"https://urbano.dev.mpr.mipaquete.com","enabled":true,"type":"default"},{"key":"uriRoles","value":"https://role.dev.mipaquete.com","enabled":true,"type":"default"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://mipaquete.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":"DEV","value":"14212363-b446f5f1-e2ec-4526-91c4-d3bee4e791b8"}],"canonicalUrl":"https://api.documentacion.mipaquete.com/view/metadata/Tzm8GFfQ"}