API - Ordini

/orders
Questo endpoint viene utilizzato per interrogare i tuoi ordini nell'API di Lengow. Seleziona parametri/filtri accettati nella tua query per affinare la tua richiesta.

/orders/actions
Questo endpoint ti permette di eseguire azioni sui tuoi ordini.

GET ordini e convenzioni

GET /orders/

Questa è l'entrata principale della nostra API! Questo endpoint ti fornirà un elenco di tutti i tuoi ordini. Completa questa richiesta GET con parametri/filtri per ottenere esattamente ciò che stai cercando. 

Convenzioni

Trova di seguito alcuni punti di convenzione che dovresti conoscere prima di fare una richiesta all'API di Lengow.

  • 1. Paginazione

L'endpoint degli ordini supporta la paginazione. Quando omesso, il valore predefinito per la pagina è 1.
L'API può mostrare un massimo di 100 risultati per pagina con il parametro page_size. 

Esempio
/orders/?account_id=1 → Pagina 1 - implicita (di default)
/orders/?account_id=1&page=5&page_size=50 → Pagina 5 - esplicita (5 pagine con max 50 risultati per pagina)

  • 2. Ordinamento

Puoi controllare l'ordinamento dei risultati con il parametro di ordinamento. Per invertire l'ordinamento, puoi prefissare il tuo campo con -Elenco dei campi di ordinamento supportati qui.  

L'ordinamento predefinito è:marketplace-marketplace_order_date-imported_at
Esempio:  /orders/?account_id=1&ordering=marketplace,-updated_at

  • 3. Parametri di query (Filtraggio)

Puoi inviare parametri di query con le tue richieste utilizzando il campo URL e la scheda Params.
account_id è un parametro obbligatorio. Usalo per qualsiasi richiesta/azione che invii all'API
Questi parametri di query ti aiuteranno a ottenere un ordine specifico per esempio, aggiungendo il "&marketplace_order_id" o ottenere tutti gli ordini da un marketplace specifico.Esempio: /orders/?account_id=1&marketplace=menlook 

  • 4.  Cambiare la valuta

Di default, tutti i campi importo sono restituiti nella valuta del tuo account.

Se vuoi cambiare la valuta, puoi utilizzare il parametro set_currency. Il valore deve essere specificato come tre caratteri (ISO 4217).
Esempio:  /orders/?account_id=1&set_currency=USD  

Usa quanti più parametri desideri con il simbolo "&".
Esempio:  /orders/?account_id=1&lengow_status=waiting_shipment&marketplace_order_id=1123456789  

 

Tipica risposta dell'API GET ordine

Le informazioni recuperate differiscono da un marketplace all'altro.
Il marketplace decide quali dati rendere disponibili nella loro API e in quali campi. Nell'API di Lengow, questi dati vengono visualizzati come forniti.

Esempio di risposta 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": "Spedito",
"lengow_status": "spedito",
"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": "Sterlina britannica"
},
"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": "Altro: 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": "Spedito",
"lengow_status": "spedito",
"title": "Prodotto TEST",
"category": null,
"url_product": nu:
"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
}
]
}

Nella risposta, troverai diversi elementi inviati dal marketplace tutti classificati in diversi oggetti con molteplici variabili.

Tutti i dettagli dell'ordine inviati dal marketplace come il marketplace_order_id, marketplace_status (stato dell'ordine), total_order, marketplace_order_date ti aiuteranno a prendere provvedimenti sul tuo ordine.

Tutti gli articoli dell'ordine che fanno parte dell'ordine. Ci può essere solo un articolo (nel caso in cui il cliente ordina solo 1 articolo), o più nel caso in cui il cliente ordina più di un articolo all'interno dello stesso ordine del cliente.

Suggerimento: Trova l'informazione "is_delivered_by_marketplace" nell'oggetto "tracking".

Elenco dei parametri supportati

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

Trova di seguito l'elenco dei possibili parametri che puoi aggiungere alle tue richieste per questo endpoint per filtrare i risultati:

  • account_id: id del tuo account Lengow. Filtro obbligatorio. Usalo per qualsiasi richiesta o azione
  • marketplace: nome del marketplace, può essere più di uno ma separali con la virgola. Esempio: "amazon_uk", o "amazon_uk,darty"
  • marketplace_order_id: ID dell'ordine
  • merchant_order_id
  • lengow_status: Lo stato Lengow, può essere uno o più stati ma separali con la virgola. Esempio: "spedito", "spedito, in attesa di spedizione"
  • marketplace_status
  • lengow_line_status: Per ottenere ordini con almeno una linea di ordine allo stato richiesto. Esempio: "lengow_line_status=rimborsato"
  • marketplace_order_date_from: Obbligatorio. Di default, impostato a giorno corrente - 7 giorni.
  • marketplace_order_date_to:  Per impostazione predefinita, impostato sul giorno corrente.
  • order_type: Esempio: "is_business", "is_business, is_express"
  • imported_from
  • imported_to
  • updated_from
  • updated_to
  • set_currency
Nota che se usi un parametro non supportato dalla nostra API o non ancora sviluppato, la tua richiesta potrebbe finire in errore o il parametro sarà semplicemente ignorato.
Esempio: "is_delivered_by_marketplace" non è un filtro valido, ma esiste nella risposta API come campo. Quindi sarà ignorato se utilizzato in una richiesta o azione.
Ogni marketplace ha il suo stato. In Lengow, tutti questi stati vengono convertiti in uno stato Lengow   

Ottieni tutte le azioni sugli ordini

GET /orders/actions/ 
Puoi monitorare lo stato di ogni azione con i campi “queued” e “processed”.
  • queued: true 
Significa che l'azione è in attesa di elaborazione (o riprova in caso di errore)
  • "queued": false
Significa che l'azione è stata elaborata
  • “processed”: true 
Significa che l'azione è valida ed è stata inviata con successo
  • "processed": false
Significa che l'azione non è valida, controlla il parametro "error".
Esempio: 
{
"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
},
Questa azione "GET" ti permette anche di verificare se l'ordine è in errore guardando il parametro "errors".
Leggi i nostri casi d'uso per ulteriori dettagli.

Crea un'azione su un ordine

POST /orders/actions/
Con questo endpoint puoi fare azioni sui tuoi ordini.

  • Qui è dove puoi spedire, annullare o rimborsare un ordine se queste azioni sono accettate dal marketplace.
Questo articolo è stato tradotto automaticamente. In caso di dubbio, faccia riferimento alle versioni originali in inglese o in francese.

Articoli in questa sezione

Accedi al centro assistenza per le nostre soluzioni di "Market Intelligence".
NetRivals & NetMonitor