Consulta de información de ítems de retiro de stock por shipment para Carta Porte desde México

Contenidos

Introducción Request Response Ejemplos de status Codes

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

Dado un ID de shipment, esta API devuelve los datos (lista de productos) 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/shipping/fiscal/{site_id}/withdrawal/shipment/{shipment_id}/items/details?access_token={access_token}

Parámetro	Tipo	Descripción
site_id	String	Id de site. Valor posible: MLM
shipment_id	String	Id del envío
access_token	String	Token de acceso

Response

{
  "package": {
    "items": [
      {
        "category": int,
        "description": "string",
        "unit_code": "string",
        "quantity": int,
        "dimensions": {
          "height":int,
          "width":int,
          "length":int,
          "weight":int,
        },
      },
    ],
    "total_items": int,
  },
  "return_reverse_logistics_collection": ""
 }

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: "Shipment id not found", como en el ejemplo de la matriz anterior.

Parámetro	Tipo	Descripción
package	Object	Paquetes del envío
package.items	List	Lista de mercancías del envío
package.items.category	Int	Atributo correspondiente en SAT para expresar la clave de producto de los bienes o mercancías que se trasladan en los distintos medios de transporte.
package.items.description	String	Descripción de la mercancía
package.items.unit_code	String	Atributo 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.
package.items.quantity	Int	Cantidad de mercancías
package.items.dimensions	Object	Información sobre la dimensión de la mercancía
package.items.dimensions.height	Int	Altura de la mercancía
package.items.dimensions.width	Int	Ancho de la mercancía
package.items.dimensions.length	Int	Largo de la mercancía
package.items.dimensions.weight	Int	Peso en gramos de la mercancía
package.total_items	String	Cantidad total de mercancías en el envío
return_reverse_logistics_collection	String	Expresa el uso de alguno de los servicios de logística inversa, recolección o devolución para el traslado de los bienes y/o mercancías. Valores: Sí o "" (string vacía)

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.