Consulta de información de Carta Porte por ruta desde México

Contenidos

Introducción Request Response Ejemplos de status Codes

La API de consulta de informaciones de carta porte por ruta tiene como objetivo servir datos de ruta y envíos a los carriers logistics que forman parte del transporte y que quieren generar el documento fiscal para México (cfdi+carta-porte).

Dado una ID de ruta, esta API devuelve los datos correspondientes (lista de envíos y costo) para la misma.

Importante:

Asegúrese de que ya tiene aplicación y token válidos, y que está autorizado para usar este endpoint
Por seguridad se utilizará OAuth

Request

GET https://api.mercadolibre.com/routes/{route_id}/carta-porte-details?access_token={access_token}

Parámetro	Tipo	Descripción
route_id	String	Id de la ruta
access_token	String	Token de acceso

¿Cómo obtener el ID de la ruta desde la herramienta de Logistics?

En la herramienta de Logistics Monitoreo, acceder con tu usuario y contraseña y buscar el ID cómo en el ejemplo de a continuación

Response

{
  "id": "12345678",
  "cost": float,
  "registration_istmo": "",
  "origin_pole_location": "",
  "destination_pole_location": "",
  "shipments": [{
    "id": "shipment_id",
    "url": "/shipments/shipment_id/carta-porte-details/step_type"
  }]
}

La respuesta es una matriz por entidad / tipo. Si no se pueden encontrar los datos fiscales de una entidad específica, se retorna el error: "Route id not found", como en el ejemplo de la matriz anterior.

Parámetro	Tipo	Descripción
id	String	Id de la ruta
cost	Float	Costo del flete
registration_istmo	String	Indica sí el traslado de los bienes y/o mercancías se realiza al interior de los Polos de Desarrollo para el Bienestar del istmo de Tehuantepec. Valores: Sí o "" (string vacía)
origin_pole_location	String	Indica dónde inicia el traslado de los bienes y/o mercancías al interior de los Polos de Desarrollo para el Bienestar del istmo de Tehuantepec. Valores: (01 al 06)
destination_pole_location	String	Indica la región en donde termina el traslado de los bienes y/o mercancías al interior de los Polos de Desarrollo para el Bienestar del istmo de Tehuantepec. Valores: (01 al 06)
shipments	List	Listado de los envíos
shipments.id	String	Id del envío
shipments.url	String	URL para obtener detalles del envío
shipments.url.shipment_id	String	Id del despacho/romaneio
shipments.url.step_type	String	Nombre de la sección deseada. Valores posibles: first_mile, middle_mile, last_mile

Ejemplos de status Codes

Si ocurre un error, la API devolverá un estado HTTP distinto de 200 con el error, el mensaje y la causa del mismo, y el content-type será application/json.

403 (NOT_OK)

Ocurre un error 403 por falta de acceso a esta API.

{
  "message": "Access revoked, consult staff to check your permissions",
  "error": "unexpected_error",
  "status": 403,
  "cause": ["error_getroute"]
}

404 (NOT_OK)

Ocurre un error 404 cuando se incluye una identificación de ruta incorrecta.

{
  "message": "An error occurred while trying to get route details",
  "error": "route_not_found",
  "status": 404,
  "cause": ["error_getroute"]
}

500 (INTERNAL_ERROR)

Ocurre un error 500 cuando se produce una falla interna a esta API.

{
  "message": "Error when try to obtain shipment information",
  "error": "internal_server_error",
  "status": 500,
  "cause": ["INTERNAL_ERROR"]
}

Código HTTP	Content type	Response body	Descripción
200	application/json	JSON (ejemplo de arriba)	Cuando se obtienen los datos de la ruta correctamente.
403	application/json	{"message": "Access revoked, consult staff to check your permissions"}	Cuando falta acceso a esta API.
404	application/json	{"message": "An error occurred while trying to get route details"...}	Cuando se incluye una identificación de ruta incorrecta.
500	application/json	{"message": "Error when try to obtain route information"}	Cuando ocurre una falla interna a esta API.