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

Contenidos

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

Dado un ID de inventario, esta API devuelve los datos (productos) del mismo.

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

Request

GET https://api.mercadolibre.com/inbound/inventory/{inventory_id}/carta-porte-details?access_token={access_token}
Parámetro
Tipo
Descripción
inventory_idStringId del inventario
access_tokenString
Token de acceso

Response

{
  "category": int,
  "description": "string",
  "unit_code": "string",
  "dangerous_material": "string",
  "dangerous_material_key": "string",
  "package_key": "string",
  "package_description": "string",
  "dimensions": {
      "height":float,
      "width":float,
      "length":float,
      "weight":float
  },
  "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: "Inventory id not found", como en el ejemplo de la matriz anterior.

Parámetro
Tipo
Descripción
categoryIntAtributo correspondiente en SAT para expresar la clave de producto de los bienes o mercancías que se trasladan en los distintos medios de transporte.
descriptionStringDescripción de la mercancía
unit_codeStringAtributo para precisar la clave de unidad de medida estandarizada aplicable para la cantidad de los bienes o mercancías que se trasladan en los distintos medios de transporte. La unidad debe corresponder con la descripción de los bienes o mercancías registrados.
dangerous_materialStringIndica si el producto es material peligroso. Siendo valor “1“ para material peligroso y “0“ para no peligroso.
dangerous_material_keyStringCódigo del material peligroso. Campo vacío cuando no es peligroso.
package_keyStringClave del package.
package_descriptionStringDescripción del package.
dimensionsObjectInformación sobre la dimensión de la mercancía
dimensions.heightFloatAltura de la mercancía
dimensions.widthFloatAncho de la mercancía
dimensions.lengthFloatLargo de la mercancía
dimensions.weightFloatPeso en gramos de la mercancía
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": [""]
}

404 (NOT_OK)

Ocurre un error 404 cuando se brinda una identificación de inventario incorrecta.

{
  "message": "Error when try to obtain inbound inventory information",
  "error": "inventory_not_found",
  "status": 404,
  "cause": [""]
}

500 (INTERNAL_ERROR)

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

{
  "message": "Error when try to obtain inbound inventory 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 del inventario correctamente.
403application/json{"message": "Access revoked, consult staff to check your permissions"}Cuando falta acceso a esta API.
404application/json{"message": "Error when try to obtain inbound inventory information"...}Al pasar una identificación de inventario incorrecta.
500application/json{"message": "Error when try to obtain inbound inventory information"}Cuando ocurre una falla interna a esta API.