API - Bestellungen

/orders
Dieser Endpunkt wird verwendet, um Ihre Bestellungen in der Lengow API abzufragen. Wählen Sie akzeptierte Parameter/Filter in Ihrer Abfrage aus, um Ihre Anfrage zu verfeinern.

/orders/actions
Dieser Endpunkt ermöglicht es Ihnen, Aktionen an Ihren Bestellungen durchzuführen.

GET Bestellungen und Konventionen

GET /orders/

Dies ist der Haupteingang unserer API! Dieser Endpunkt liefert Ihnen eine Liste aller Ihrer Bestellungen. Ergänzen Sie diese GET-Anfrage mit Parametern/Filtern um genau das zu bekommen, wonach Sie suchen. 

Konventionen

Finden Sie unten einige Konventionspunkte, die Sie kennen sollten, bevor Sie eine Anfrage an die Lengow API stellen.

  • 1. Pagination

Der Bestell-Endpunkt unterstützt Pagination. Wenn weggelassen, ist der Standardwert für die Seite 1.
Die API kann anzeigen maximal 100 Ergebnisse pro Seite mit dem Parameter page_size. 

Beispiel
/orders/?account_id=1 → Seite 1 - implizit (standardmäßig)
/orders/?account_id=1&page=5&page_size=50 → Seite 5 - explizit (5 Seiten mit max 50 Ergebnissen pro Seite)

  • 2. Sortierung

Sie können die Sortierung der Ergebnisse mit dem Sortierungsparameter steuern. Um die Sortierung umzukehren, können Sie Ihr Feld mit -Liste der unterstützten Sortierungsfelder hier voranstellen.  

Die Standard-Sortierung ist:Marktplatz-Marktplatz-Bestelldatum-importiert_am
Beispiel:  /orders/?account_id=1&Sortierung=Marktplatz,-aktualisiert_am

  • 3. Abfrageparameter (Filterung)

Sie können Abfrageparameter mit Ihren Anfragen senden, indem Sie das URL-Feld und den Params-Tab verwenden.
account_id ist ein obligatorischer Parameter. Verwenden Sie ihn für jede Anfrage/Aktion, die Sie an die API senden
Diese Abfrageparameter helfen Ihnen, zum Beispiel eine spezifische Bestellung zu erhalten, indem Sie den "&marketplace_order_id" hinzufügen oder alle Bestellungen von einem spezifischen Marktplatz erhalten.Beispiel: /orders/?account_id=1&Marktplatz=menlook 

  • 4.  Änderung der Währung

Standardmäßig werden alle Betragsfelder in der Währung Ihres Kontos zurückgegeben.

Wenn Sie die Währung ändern möchten, können Sie den set_currency-Parameter verwenden. Der Wert muss als drei Zeichen (ISO 4217) angegeben werden.
Beispiel:  /orders/?account_id=1&set_currency=USD  

Verwenden Sie so viele Parameter wie Sie möchten mit dem Symbol "&".
Beispiel:  /orders/?account_id=1&lengow_status=waiting_shipment&marketplace_order_id=1123456789  

 

Typische GET-Bestell-API-Antwort

Die abgerufenen Informationen unterscheiden sich von Marktplatz zu Marktplatz.
Der Marktplatz entscheidet, welche Daten sie in ihrer API zur Verfügung stellen und in welchen Feldern. In der Lengow API werden diese Daten so angezeigt, wie sie bereitgestellt werden.

Beispiel für eine API-Antwort:

{
"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": "Versendet",
"lengow_status": "versendet",
"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": "Britisches Pfund"
},
"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": "Andere: 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": "Versendet",
"lengow_status": "versendet",
"title": "Produkt 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
}
]
}

In der Antwort finden Sie mehrere Elemente, die vom Marktplatz gesendet wurden, alle in verschiedenen Objekten mit mehreren Variablen klassifiziert.

Alle Details der vom Marktplatz gesendeten Bestellung wie die Marktplatzbestellungs-ID, Marktplatzstatus (Status der Bestellung), Gesamtbestellung, Marktplatzbestelldatum helfen Ihnen, Maßnahmen für Ihre Bestellung zu ergreifen.

Alle Bestellartikel, die Teil der Bestellung sind. Es kann nur ein Artikel sein (falls der Kunde nur 1 Artikel bestellt), oder mehr, falls der Kunde mehr als einen Artikel innerhalb der gleichen Kundenbestellung bestellt.

Tipp: Finden Sie die Information "is_delivered_by_marketplace" im Objekt "tracking".

Liste der unterstützten Parameter

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

Finden Sie unten die Liste der möglichen Parameter, die Sie Ihren Anfragen für diesen Endpunkt hinzufügen können.

  • account_id:  Ihre Lengow-Konto-ID. Obligatorischer Filter. Verwenden Sie es für jede Anfrage oder Aktion
  • marketplace_order_date_from:  Obligatorisch. Standardmäßig auf den aktuellen Tag - 7 Tage eingestellt. 
  • marketplace: Name des Marktplatzes, kann mehrere sein, aber trennen Sie sie mit einem Komma. Beispiel: "amazon_uk", oder "amazon_uk,darty"  
  • marketplace_order_id: ID der Bestellung
  • merchant_order_id
  • lengow_status: Der Lengow-Status, kann ein oder mehrere Status sein, aber trennen Sie sie mit einem Komma. Beispiel: "versendet", "versendet, warten auf Versand"
  • marketplace_status
  • marketplace_order_date_to:  Standardmäßig auf den aktuellen Tag eingestellt  
  • order_type: Beispiel: "is_business", "is_business, is_express"
  • imported_from
  • ng>
  • importiert_zu
  • aktualisiert_von
  • aktualisiert_zu
  • setze_währung
  • keine_währungsumrechnung
  •  Katalog_ids: Beispiel: " id1,id2" 
Hinweis dass, wenn Sie einen Parameter verwenden, der von unserer API nicht unterstützt wird oder noch nicht entwickelt wurde, Ihre Anfrage möglicherweise fehlschlägt oder der Parameter einfach ignoriert wird.
Beispiel: "is_delivered_by_marketplace" ist kein gültiger Filter, existiert aber in der API-Antwort als Feld. Daher wird es ignoriert, wenn es in einer Anfrage oder Aktion verwendet wird.
Jeder Marktplatz hat seinen eigenen Status. In Lengow werden alle diese Status in einen Lengow-Status umgewandelt.    

Erhalten Sie alle Aktionen auf Bestellungen

GET /orders/actions/ 
Sie können den Status jeder Aktion mit den Feldern “queued” und “processed” verfolgen.
  • queued: true 
Bedeutet, dass die Aktion auf die Verarbeitung wartet (oder bei einem Fehler erneut versucht wird)
  • "queued": false
Bedeutet, dass die Aktion verarbeitet wurde
  • “processed”: true 
Bedeutet, dass die Aktion gültig ist und erfolgreich gesendet wurde
  • "processed": false
Bedeutet, dass die Aktion ungültig ist, überprüfen Sie den "error" Parameter.
Beispiel: 
{
"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
},
Diese "GET"-Aktion ermöglicht es Ihnen auch, zu überprüfen, ob die Bestellung einen Fehler aufweist, indem Sie den "Fehler"-Parameter betrachten.
Lesen Sie unsere Anwendungsfälle für weitere Details.

Erstellen Sie eine Aktion auf einer Bestellung

POST /orders/actions/
Mit diesem Endpunkt können Sie Aktionen auf Ihren Bestellungen durchführen.

  • Hier können Sie eine Bestellung versenden, stornieren oder erstatten, wenn diese Aktionen vom Marktplatz akzeptiert werden.
Dieser Artikel wurde automatisch übersetzt. Bei Unsicherheiten bitten wir Sie, die Originalversionen auf Französisch oder Englisch zu konsultieren.

Beiträge in diesem Abschnitt

Unsere Supportzeiten:
Montag bis Freitag von 9:00 - 18.30 Uhr