API - Casi d'uso

• Risposta API

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"marketplace": "laredoute",
"account_id": 1,
"marketplace_country_iso2": "FR",
"marketplace_order_id": "2020.111.123456789",
"merchant_order_id": [
"1234567"
],
"marketplace_status": "DaSpedire",
"stato_lengow": "in attesa_di_spedizione",
"posizione_workflow": 5,
"data_ordine_marketplace": "2020-11-12T15:23:18Z",
"totale_ordine": 74.8,
"totale_tasse": "0.00",
"spedizione": 9.9,
"sconto": 0.0,
"commissione": null,
Trova qui alcuni consigli e casi d'uso per aiutarti a impostare le tue richieste e azioni con la nostra API.
Per illustrare questi casi d'uso, abbiamo scelto di utilizzare un commerciante di prova.

Chiamiamo il nostro commerciante di prova "Julia" e diciamo che il suo numero di conto è "1". 
Si prega di notare che lei sta utilizzando Postman per effettuare tutte le sue chiamate API.
I risultati saranno in formato JSON
Questi casi d'uso sono puri esempi


Maggiori informazioni su Postman e su come creare una collezione (gruppo di richieste salvate) qui.  

Connettiti alla nostra API: Ottieni il token di accesso


Il primo passo prima di effettuare una chiamata di richiesta o qualsiasi azione all'interno dell'API di Lengow è di entrare nell'API. 

Per farlo, Julia ha bisogno di raccogliere le sue credenziali dal suo account Lengow che sono: 
- ID account Lengow

- token segreto

- token 
 e aprire Postman. 

Poi, una volta che ha impostato un nuovo ambiente in Postman con le sue credenziali, può procedere e POST la prima chiamata che è:
 
POST /access/get_token




L'API restituisce un token di accesso come questo: 

{
    "token": "69946b78-edae-49b8-8874-6fb025e09a58",
    "account_id": 1
}
Aggiunge questo token al suo ambiente Postman sotto la variabile LENGOW_AUTH (vedi immagine sotto).


 
  
Il "token" inviato dall'API di Lengow dura 3600 secondi e può ora essere utilizzato come Lengow_AUTH in Postman.

Suggerimento: Con l'aiuto dei tuoi sviluppatori puoi impostare uno script che effettua questa chiamata automaticamente ogni ora.    
Controlla le azioni sugli ordini
Julia ha corretto una delle sue azioni di spedizione su un ordine. Vuole controllare che la sua ultima azione sia corretta e che l'azione che ha inviato sia stata correttamente elaborata dall'API di Lengow verso l'API del canale.




GET /orders/actions/  


Dall'API di Lengow, interroga questo ordine specifico utilizzando il parametro "&marketplace_order_id"  e utilizza l'ID del suo ordine (vedi sotto).

-- endpoint /orders/actions --

-- metodo GET --

GET /orders/actions/?account_id=1&marketplace_order_id=12-05319-12345

-- risposta API --

{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 13244460,
"marketplace_order_id": "12-05319-123452",
"account_id": 1,
"marketplace": "ebay_fr",
"action_type": "ship",
"processed": true,
"queued": false,
"tracking_number": "2L01286914523",
"tracking_url": null,
"carrier": "FR_ColiposteColissimoRecommended",
"custom_carrier": null,
"line": "193393034918-1749999860009",
"declared_value": null,
"currency_code": null,
"invoice_number": null,
"shipping_method": null,
"shipping_date": null,
"shipping_service_id": null,
"shipping_service_offer_id": null,
"created_at": "2020-07-02T08:03:37.912433Z",
"updated_at": "2020-07-02T08:03:39.262053Z",
"weight": null,
"weight_unit": null,
"comment": null,
"delay": null,
"reason": null,
"charges": null,
"errors": null,
"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
},
{
"id": 13244455,
"marketplace_order_id": "12-05319-123452",
"account_id": 1,
"marketplace": "ebay_fr",
"action_type": "ship",
"processed": false,
"queued": false,
"tracking_number": null,
"tracking_url": null,
"carrier": "FR_ColiposteColissimoRecommended",
"custom_carrier": null,
"line": "193393034918-1749999860009",
"declared_value": null,
"currency_code": null,
"invoice_number": null,
"shipping_method": null,
"shipping_date": null,
"shipping_service_id": null,
"shipping_service_offer_id": null,
"created_at": "2020-07-02T08:02:50.609088Z",
"updated_at": "2020-07-02T08:02:50.681358Z",
"weight": null,
"weight_unit": null,
"comment": null,
"delay": null,
"reason": null,
"charges": null,
"errors": "Per l'azione di spedizione dell'ordine è necessario il numero di tracking E il corriere",
>"processing_fee": null,
"currency": {
"iso_a3": "EUR",
"symbol": "€",
"name": "Euro"
},
"original_currency": {
"iso_a3": "EUR",
"symbol": "€",
"name": "Euro"
},
"original_total_order": 74.8,
"original_total_tax": "0.00",
"original_shipping": 9.9,
"original_discount": 0.0,
"original_commission": null,
"original_processing_fee": null,
"comments": null,
"invoice_number": null,
"invoice_url": null,
"payments": [],
"packages": [
{
"cart": [
{
"id": 8623271,
"marketplace_order_line_id": "2020.111.123456789-1",
"marketplace_product_id": "4001072020053",
"merchant_product_id": {
"field": "ID_PRODUCT",
"id": "111111"
},
"feed_id": 12345,
"marketplace_package_id": null,
"marketplace_status": "ToShip",
"lengow_status": "waiting_shipment",
"title": "Visionneuse diapositive automatique - Diascop 3",
"category": "Accueil > Accessoires > Visionneuses",
"url_product": null,
"url_image": null,
"order_line_meta": {
"DeliveryMode": "Home",
"DeliveryType": "Regular"
},
"amount": "64.90",
"tax": "0.00",
"discount": null,
"shipping": null,
"original_amount": "64.90",
"original_tax": "0.00",
"original_discount": null,
"original_shipping": null,
"quantity": 1,
"documents": [],
"created_at": null,
"updated_at": null,
"orderline_types": []
}
],
"delivery": {
"id": 151186892,
"type": "delivery",
"first_line": "500 AVENUE TEST",
"zipcode": "69300",
"city": "CALUIRE ET CUIRE",
"vat_number": null,
"company": null,
"civility": "Monsieur",
"first_name": null,
"last_name": null,
"second_line": "",
"complement": "ETAGE 3E",
"phone_home": null,
"phone_office": null,
"phone_mobile": "06700000000",
"full_address": null,
"full_name": "TEST BOB DUPONT",
"email": "*****.fr",
"metas": null,
"state_region": null,
"common_country_iso_a2": "FR",
"trackings": [
{
"number": null,
"method": "Home / Regular",
"carrier": null,
"url": null,
"is_delivered_by_marketplace": null,
"parcel_weight": null,
"shipped_at": null,
"pickup_store": {
"id": null
},
"relay": {
"id": null,
"name": null
},
"marketplace_order_line_ids": [
"2020.111.123456789-1"
]
}
]
}
}
],
"billing_address": {
"id": 151198390,
"type": "billing",
"first_line": "500 AVENUE TEST",
"zipcode": "69300",
"city": "CALUIRE ET CUIRE",
"vat_number": null,
"company": null,
"civility": "Monsieur",
"first_name": null,
"last_name": null,
"second_line": "",
"complement": "ETAGE 3E",
"phone_home": null,
"phone_office": null,
"phone_mobile": "06700000000",
"full_address": null,
"full_name": "TEST BOB DUPONT",
"email": "*****.fr",
"metas": null,
"state_region": null,
"common_country_iso_a2": "FR"
},
"contact_address": null,
"documents": [],
"imported_at": "2020-11-12T16:09:07.256186Z",
"updated_at": "2020-11-12T16:32:15.849000Z",
"order_meta": {
"checksum": "b4aa946ef504ed758359db880c03bd62"
},
"anonymized": false,
"order_types": []
}
]
}


L'ordine è nello stato "waiting_shipment". 

Dal parametro  "delivery" > "trackings" della risposta API, Julia può controllare il metodo di consegna scelto dal cliente:


"method": "Home / Regular"

Da questo parametro "tracking", si possono trovare altre informazioni e potrebbero essere completate a seconda del metodo di consegna scelto dal cliente:
"is_delivered_by_marketplace": null,
"pickup_store": { "id": null },
"relay": { "id": null, "name": null


Nota: Se fosse stato scelto il metodo "Relais / Regular", il parametro "relay" dell'ordine sarebbe stato completato con un Identificatore e un nome del punto di ritiro.



PASSAGGIO 2

Julia poi interroga le informazioni generali del marketplace per sapere quali sono gli elementi obbligatori da compilare per spedire correttamente il suo ordine. 
Dall'API, questa volta usa l'endpoint /marketplace:


GET /marketplaces/?marketplace=laredoute  

Nella risposta che l'API di Lengow restituisce, potrebbe trovare 


lista degli stati dell'ordine 
Azioni autorizzate sugli ordini e parametri obbligatori da completare per azione
Corrieri autorizzati dal marketplace nel tag "carriers"



Per La Redoute, trova: 
 
 "actions": {
                "ship": {
                    "args": [
                        "carrier",
Poi consulta il tag "carrier" per sapere se i valori validi sono obbligatori o no:
"carrier": {
                            "type": "string",
                            "valid_values": {},
                            "default_value": "",
                            "accept_free_values": true 
Questo significa che per convalidare la spedizione del suo ordine La Redoute (consegna a domicilio), Julia deve fornire


le informazioni "carrier"
un "tracking_number"


Poiché non esiste un elenco di corrieri obbligatori, può utilizzare il corriere di sua scelta.
Recupera documenti
Julia, il nostro commerciante di prova, ha ricevuto un nuovo ordine dal marketplace Zalando. Vuole scaricare i documenti che le viene chiesto di allegare al pacco: fattura, nota di consegna e modulo di reso.
Nota: Questi documenti sono redatti da Lengow e possono anche essere scaricati sulla piattaforma Lengow, come spiegato nella nostra guida Zalando. 
PASSO 1
Una volta connessa all'API di Lengow, interroga il suo ordine utilizzando il punto finale /orders in questo modo:

GET /orders/?account_id=1&marketplace_order_id=10987654321
Nella risposta che l'API di Lengow restituisce, trova la sezione "documenti", dove può ottenere gli ID di questi documenti:
"documents": [
{
"id": 2111112,
"marketplace_doc_id": "DELIVERY_NOTE_123fc456-f789-101b-b12g-a134c1235678",
"url": "http://api.lengow.io/v3.0/document/2111112",
"created_at": "2022-05-14T06:26:19.479581Z",
"doc_type": {
"lengow_type": "DELIVERY",
"marketplace_code": "DELIVERY_NOTE",
"marketplace_label": "Note di consegna Zalando"
}
},
{
"id": 2111111,
"marketplace_doc_id": "RETURN_123fc456-f789-101b-b12g-a134c1235678",
"url": "http://api.lengow.io/v3.0/document/2111111",
"created_at": "2022-05-14T06:26:19.478343Z",
"doc_type": {
"lengow_type": "RETURN",
"marketplace_code": "RETURN",
"marketplace_label": "Modulo di reso Zalando"
}
},
{
"id": 2111110,
"marketplace_doc_id": "BILL_123fc456-f789-101b-b12g-a134c1235678",
"url": "http://api.lengow.io/v3.0/document/2111110",
"created_at": "2022-05-14T06:26:19.475280Z",
"doc_type": {
"lengow_type": "BILL",
"marketplace_code": "BILL",
"marketplace_label": "Fattura Zalando"
}
}
]

PASSO 2
Utilizzando gli ID dei documenti che ha trovato (2111110, 2111111 e 2111112 in questo esempio), Julia scarica i documenti corrispondenti utilizzando il punto finale /document (una chiamata per ogni documento):
GET /document/2111110?account_id=1
Risultato visibile in Postman: