1. Help Center Lengow
  2. Información Técnica
  3. API de Lengow

API - Pedidos

/orders
Este endpoint se utiliza para consultar tus pedidos en la API de Lengow. Selecciona parámetros/filtros aceptados en tu consulta para refinar tu solicitud.

/orders/actions
Este endpoint te permite realizar acciones en tus pedidos.

GET pedidos y convenciones

GET /orders/

¡Esta es la entrada principal de nuestra API! Este endpoint te entregará una lista de todos tus pedidos. Completa esta solicitud GET con parámetros/filtros para obtener exactamente lo que estás buscando. 

Convenciones

Encuentra a continuación algunos puntos de convención que debes conocer antes de hacer una solicitud a la API de Lengow.

  • 1. Paginación

El endpoint de pedidos admite paginación. Cuando se omite, el valor predeterminado para la página es 1.
La API puede mostrar un máximo de 100 resultados por página con el parámetro page_size. 

Ejemplo: 
/orders/?account_id=1 → Página 1 - implícito (por defecto)
/orders/?account_id=1&page=5&page_size=50 → Página 5 - explícito (5 páginas con un máximo de 50 resultados por página)

  • 2. Ordenación

Puedes controlar la ordenación de los resultados con el parámetro de ordenación. Para invertir el orden, puedes prefijar tu campo por -Lista de campos de ordenación admitidos aquí.  

La ordenación predeterminada es:marketplace-marketplace_order_date-imported_at
Ejemplo:  /orders/?account_id=1&ordering=marketplace,-updated_at

  • 3. Parámetros de consulta (Filtrado)

Puedes enviar parámetros de consulta con tus solicitudes utilizando el campo URL y la pestaña Params.
account_id es un parámetro obligatorio. Úsalo para cualquier solicitud/acción que envíes a la API
Estos parámetros de consulta te ayudarán a obtener un pedido específico, por ejemplo, añadiendo el "&marketplace_order_id" o para obtener todos los pedidos de un marketplace específico.Ejemplo: /orders/?account_id=1&marketplace=menlook 

  • 4.  Cambiando la moneda

Por defecto, todos los campos de cantidad se devuelven en la moneda de tu cuenta.

Si quieres cambiar la moneda, puedes usar el parámetro set_currency. El valor debe especificarse como tres caracteres (ISO 4217).
Ejemplo:  /orders/?account_id=1&set_currency=USD  

Usa tantos parámetros como quieras con el símbolo "&".
Ejemplo:  /orders/?account_id=1&lengow_status=waiting_shipment&marketplace_order_id=1123456789  

 

Respuesta típica de la API de pedido GET

La información recuperada difiere de un marketplace a otro.
El marketplace decide qué datos hacen disponibles en su API y en qué campos. En la API de Lengow, estos datos se muestran tal como se proporcionan.

Ejemplo de respuesta de la API:

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"marketplace": "amazon_uk",
"account_id": 1,
"marketplace_country_iso2": "GB",
"marketplace_order_id": "order1",
"merchant_order_id": null,
"marketplace_status": "Shipped",
"lengow_status": "shipped",
"workflow_rank": 6,
"marketplace_order_date": "2019-03-22T17:54:34.369000Z",
"total_order": 809.2900000000001,
"total_tax": "134.45",
"shipping": 2.6,
"discount": 0,
"commission": "-56.47",
"processing_fee": null,
"currency": {
"iso_a3": "EUR",
"symbol": "€",
"name": "Euro"
},
"original_currency": {
"iso_a3": "GBP",
"symbol": "£",
"name": "British Pound"
},
"original_total_order": 701.25,
"original_total_tax": "116.50",
"original_shipping": 2.25,
"original_discount": 0,
"original_commission": "-48.93",
"original_processing_fee": null, 
"comments": null,
"invoice_number": null,
"invoice_url": null,
"payments": [
{
"id": 1,
"checkout": null,
"status": null,
"type": "Other: Standard",
"settled_at": null,
"payment_terms": null,
"channel_order_marketplace": 1
}
],
"packages": [
{
"cart": [
{
"id": 1,
"marketplace_order_line_id": "line1",
"marketplace_product_id": "product1",
"merchant_product_id": {
"field": "ID_PRODUCT",
"id": "Product1"
},
"feed_id": 1,
"marketplace_package_id": null,
"marketplace_status": "Shipped",
"lengow_status": "shipped",
"title": "Product TEST",
"category": null,
"url_product": nul,
"url_image": null,
"order_line_meta": {
},
"amount": "806.69",
"tax": "134.45",
"discount": null,
"shipping": "2.60",
"original_amount": "699.00",
"original_tax": "116.50",
"original_discount": null,
"original_shipping": "2.25",
"quantity": 1,
"created_at": null,
"updated_at": null
}
],
"delivery": {
"id": 1,
"type": "delivery",
"first_line": "1 Rue de la Paix",
"zipcode": "44",
"city": "Nantes",
"company": null,
"civility": null,
"first_name": null,
"last_name": null,
"second_line": null,
"complement": null,
"phone_home": null,
"phone_office": null,
"phone_mobile": null,
"full_address": null,
"full_name": "Dupont",
"email": "test@lengow.amazon.co.uk",
"metas": null,
"state_region": "",
"common_country_iso_a2": "GB",
"trackings": [
{
"number": null,
"method": "Standard",
"carrier": null,
"url": null,
"is_delivered_by_marketplace": true,
"parcel_weight": null,
"shipped_at": null,
"relay": {
"name": null,
"id": null
},
"marketplace_order_line_ids": [
"line1"
]
}
]
}
}
],
"billing_address": {
"id": 2,
"type": "billing",
"first_line": null,
"zipcode": "44",
"city": "Nantes",
"company": null,
"civility": null,
"first_name": null,
"last_name": null,
"second_line": null,
"complement": null,
"phone_home": null,
"phone_office": null,
"phone_mobile": null,
"full_address": null,
"full_name": "Dupont",
"email": "test@lengow.amazon.co.uk",
"metas": null,
"state_region": "",
"common_country_iso_a2": "GB"
},
"contact_address": null,
"imported_at": "2019-03-22T20:05:35.196060Z",
"updated_at": "2019-03-25T11:48:09.071000Z",
"order_meta": {
"checksum": "fffffffggghghhgu"
},
"anonymized": false
}
]
}

En la respuesta, encontrarás varios elementos enviados por el mercado todos clasificados en diferentes objetos con múltiples variables.

Todos los detalles del pedido enviados por el mercado, como el marketplace_order_id, marketplace_status (estado del pedido), total_order, marketplace_order_date te ayudarán a tomar medidas en tu pedido.

Todos los artículos del pedido que forman parte del pedido. Puede haber solo un artículo (en caso de que el cliente pida solo 1 artículo), o más en caso de que el cliente pida más de un artículo dentro del mismo pedido del cliente.

Consejo: Encuentra la información "is_delivered_by_marketplace" en el objeto "tracking".

Lista de parámetros admitidos

GET /orders/?account_id=1&marketplace=amazon_uk,darty

Encuentra a continuación la lista de posibles parámetros que puedes agregar a tus solicitudes para este punto final para filtrar resultados:

  • account_id: id de tu cuenta de Lengow. Filtro obligatorio. Úsalo para cualquier solicitud o acción
  • marketplace: nombre del mercado, puede ser múltiple pero sepáralos con coma. Ejemplo: "amazon_uk", o "amazon_uk,darty"
  • marketplace_order_id: ID del pedido
  • merchant_order_id
  • lengow_status: El estado de Lengow, puede ser uno o varios estados pero sepáralos con coma. Ejemplo: "shipped", "shipped, waiting_shipment"
  • marketplace_status
  • lengow_line_status: Para obtener pedidos con al menos una línea de pedido en el estado solicitado. Ejemplo: "lengow_line_status=refunded"
  • marketplace_order_date_from: Obligatorio. Por defecto, se establece en el día actual - 7 días.
  • marketplace_order_date_to:  Por defecto, se establece en el día actual.
  • order_type: Ejemplo: "is_business", "is_business, is_express"
  • imported_from
  • imported_to
  • updated_from
  • updated_to
  • set_currency
Nota que si usas un parámetro no soportado por nuestra API o aún no desarrollado, tu solicitud podría terminar en error o el parámetro simplemente será ignorado.
Ejemplo: "is_delivered_by_marketplace" no es un filtro válido, pero existe en la respuesta de la API como un campo. Por lo tanto, será ignorado si se utiliza en una solicitud o acción.
Cada mercado tiene su propio estado. En Lengow, todos estos estados se convierten en un estado de Lengow   

Obtener todas las acciones en los pedidos

GET /orders/actions/ 
Puedes seguir el estado de cada acción con los campos “queued” y “processed”.
  • “queued”: true 
Significa que la acción está esperando ser procesada (o reintentando en caso de fallo)
  • "queued": false
Significa que la acción ha sido procesada
  • “processed”: true 
Significa que la acción es válida y ha sido enviada con éxito
  • "processed": false
Significa que la acción es inválida, verifica el parámetro "error".
Ejemplo: 
{
"id": 123456789,
"marketplace_order_id": "306-1234567-1234567",
"account_id": 1,
"marketplace": "amazon_de",
"action_type": "ship",
"processed": true,
"queued": false,
"tracking_number": "05348000966072J",
"tracking_url": null,
"carrier": "DPD",
"custom_carrier": null,
"line": "39751459711155",
"declared_value": null,
"currency_code": null,
"invoice_number": null,
"shipping_method": "DPD",
"shipping_date": "2020-10-28T14:35:07+01:00",
"shipping_service_id": null,
"shipping_service_offer_id": null,
"created_at": "2020-10-28T13:35:07.301140Z",
"updated_at": "2020-10-28T13:38:19.909097Z",
"weight": null,
"weight_unit": null,
"comment": null,
"delay": null,
"reason": null,
"charges": null,
"errors": "The tracking ID 05348000966072J for DPD does not match the expected format of the carrier. Please verify that you have entered the tracking ID and carrier name correctly.",
"delivery_date": null,
"delivery_experience": null,
"return_tracking_number": null,
"refund_price": null,
"refund_shipping_price": null,
"refund_mode": null,
"refund_reason": null,
"refund_quantity": null,
"refund_shipping": null,
"refund_shipping_taxes": null,
"refund_taxes": null,
"carrier_name": null,
"carrier_pickup": null,
"package_dimension_length": null,
"package_dimension_width": null,
"package_dimension_height": null,
"package_dimension_unit": null,
"from_address_name": null,
"from_address_line": null,
"from_address_city": null,
"from_address_state_province": null,
"from_address_postal_code": null,
"from_address_country_code": null,
"from_address_mail": null,
"from_address_phone": null,
"pickup_id": null,
"refund_id": null,
"return_carrier": null
},
Esta acción "GET" también te permite verificar si el pedido está en error mirando el parámetro "errors".
Lee nuestros casos de uso para más detalles.

Crear una acción en un pedido

POST /orders/actions/
Con este endpoint puedes realizar acciones en tus pedidos.

  • Aquí es donde puedes enviar, cancelar o reembolsar un pedido si estas acciones son aceptadas por el mercado.
Lengow
Actualización
Este artículo ha sido traducido automáticamente. En caso de duda, le agradecemos que consulte las versiones originales en francés o en inglés.

Artículos en esta sección

Nuestros horarios de support:
De 9:00 a 18:30 CET de lunes a viernes