- Cet endpoint est à utiliser pour interroger vos commandes dans l'API Lengow. Choisissez les paramètres/variables dans votre requête pour affiner votre demande.
- Cet endpoint vous permet d'effectuer des actions sur vos commandes.
Interrogez vos commandes
GET /orders/
- Consultez nos cas d'utilisation pour vous aider à construire vos premières requêtes et voir les possibilités offertes par notre API.
- Allez voir un exemple de réponse API pour un GET orders
Bien configurer ses requêtes
Retrouvez ci-dessous quelques points à connaître pour bien configurer vos requêtes avant de faire vos appels à l'API Lengow.
- 1. Pagination
/orders/?account_id=1&page=5&page_size=50 → Page 5 (5 pages de résultats avec max 50 résultats par pages)
- 2. Ordre des résultats
L'ordre par défaut est : marketplace-marketplace_order_date-imported_at
Exemple: /orders/?account_id=1&ordering=marketplace,-updated_at
- 3. Paramètres de requêtes (filtres)
Ces paramètres de requête vous aideront à affiner vos résultats, par exemple, en ajoutant le "&marketplace_order_id". ou à obtenir toutes les commandes d'un marché spécifique.
- 4. Changer la monnaie
Par défaut, tous les champs de montant sont renvoyés dans la devise de votre compte Lengow.
Si vous souhaitez modifier la devise, vous pouvez utiliser le paramètre set_currency.
La valeur doit être spécifiée sous forme de trois caractères (ISO 4217)
Exemple: /orders/?account_id=1&set_currency=USD
Exemple: /orders/?account_id=1&lengow_status=waiting_shipment&marketplace_order_id=1123456789
Exemple de réponse API
Les informations obtenues diffèrent d'une marketplace à l'autre.
Chaque marketplace décide des données qu'elle met à disposition dans son API et dans quels champs. Dans l'API de Lengow, ces données sont affichées telles qu'elles sont fournies.
Voici un exemple de réponse 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": null,
"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
}
]
}
Dans cet exemple de réponse, vous trouverez plusieurs éléments envoyés par la marketplace, tous classés dans différents objets avec plusieurs paramètres/variables.
Tous les détails de la commande envoyée par la marketplace tels que marketplace_order_id, marketplace_status (statut de la commande), total_order, marketplace_order_date vous aideront à agir sur votre commande.
Dans cet exemple vous voyez tous les produits de la commande et ceux qui font partie de la commande. Il peut n'y avoir qu'un seul produit (dans le cas où le client commande un seul produit), ou plusieurs dans le cas où le client commande plus d'un produit.
Liste des paramètres acceptés
GET /orders/?account_id=1&marketplace=amazon_uk,darty
Retrouvez ci-dessous la liste des paramètres/filtres possibles que vous pouvez ajouter à vos requêtes pour le endpoint /orders de notre API :
- account_id: identifiant de votre compte Lengow. obligatoire. Utilisez-le pour toute demande ou action.
- marketplace_order_date_from: Obligatoire. Par défaut, défini sur le jour actuel - 7 jours.
- marketplace: nom de la marketplace, peut être multiple mais séparez-les par une virgule Exemple: "amazon_uk", ou "amazon_uk,darty"
- marketplace_order_id: ID de la commande
- merchant_order_id
- lengow_status: Le statut Lengow. Séparer par une virgule si multiples. Exemples : "shipped", "shipped, waiting_shipment"
- marketplace_status
- lengow_line_status: Liste les commandes comportant au moins une ligne au statut demandé. Exemple : "lengow_line_status=refunded"
- marketplace_order_date_to: Par défaut défini sur le jour actuel
- order_type: Exemple: "is_business", "is_business, is_express"
- imported_from
- imported_to
- updated_from
- updated_to
- set_currency
Notez que si vous utilisez un paramètre non pris en charge par notre API, votre demande peut se terminer par une erreur ou le paramètre sera simplement ignoré.
Exemple: "is_delivered_by_marketplace" n'est pas un filtre valide, mais il existe dans la réponse de l'API en tant que champ. Il sera donc ignoré s'il est utilisé dans une requête ou une action.
Chaque marketplace a son propre statut. Dans Lengow, tous ces statuts sont convertis en statuts Lengow
Interrogez les actions sur vos commandes
- “queued”: true
- “queued”: false
- “processed”: true
- “processed”: false
{
"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
},
Créer une action sur une commande
POST /orders/actions/
Avec cet endpoint de l'API, vous pouvez effectuer des actions sur vos commandes.
- C'est ici que vous pouvez "expédier", "annuler" ou "rembourser" une commande si ces actions sont autorisées par la marketplace.