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

Contenidos

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

Dado un ID de ruta, esta API devuelve los datos correspondientes (lista de envíos del inbound) 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/inbound/route/{route_id}/carta-porte-details?access_token={access_token}
Parámetro
Tipo
Descripción
route_idStringId de la ruta
access_tokenString
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

El Id de la ruta también se puede obtener desde la pantalla de listado de la herramienta de Logistics Monitoreo cómo en el ejemplo de a continuación

Response

{
  "id": "route_id",
  "inbound_shipment": [
      {
          "id": "shipment_id",
          "url": "/inbound/shipment/{shipment_id}/carta-porte-details",
      },
      ...
  ],
  "registration_istmo": "",
  "origin_pole_location": "",
  "destination_pole_location": ""
}

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
idStringId de la ruta
inbound_shipmentListListado de los shipments
inbound_shipment.idStringId del envío del inbound
inbound_shipment.urlString
URL para obtener detalles del envío. Acceder a la API del shipments para más detalles sobre cómo realizar esta solicitud
registration_istmoStringIndica 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_locationStringIndica 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_locationStringIndica 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)

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 inbound route details. Route not found",
  "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 inbound route information",
  "error": "internal_server_error",
  "status": 500,
  "cause": ["INTERNAL_ERROR"]
}
Código HTTP
Content type
Response body
Descripción
200application/jsonJSON (ejemplo de arriba)Cuando se obtienen los datos de la ruta correctamente.
403application/json{"message": "Access revoked, consult staff to check your permissions"}Cuando falta acceso a esta API.
404application/json{"message": "An error occurred while trying to get inbound route details. Route not found"...}Cuando se incluye una identificación de ruta incorrecta.
500application/json{"message": "Error when try to obtain inbound route information"}Cuando ocurre una falla interna a esta API.