Orders

Caricamento ordini su Gsped

Questo endpoint serve a caricare ordini e relativi dettagli su Gsped per permetterne l'evasione via API o via interfaccia web con conseguente generazione delle etichette di spedizione.

Molto utile quando ci si trova a dover gestire diversi punti di evasione ordini che utilizzano l'interfaccia web di Gsped ma per cui non è possibile attivare un connettore per lo scarico automatico degli ordini.

Recupera listato ordini

GET https://api.gsped.it/[ISTANZA]/Orders

Headers

Name
Type
Description

x-api-key*

String

APIKEY fornita da Gsped

Query Parameters

Name
Type
Description

id

int[]

seleziona se id IN [id, id, ...]

client_id

int[]

seleziona se client_id IN [client_id, client_id, ...] Eventuali client_id errati o non permessi verranno ignorati

order_ref

string[]

seleziona se order_ref IN [order_ref, order_ref, ...] Ogni stringa max 50 char

email

string

seleziona se email = email Max 50 char

data_ordine_da

Y-m-d

Seleziona se data_ordine ≥ data_ordine_da

data_ordine_a

Y-m-d

Seleziona se data_ordine <= data_ordine_a

status

string[]

seleziona se status IN [status, status, ...] Max 3 char

exclude_status

string[]

seleziona se status NOT IN [status, status, ...] Max 3 char

corriere

int[]

seleziona se corriere IN [corriere, corriere, ...]

exclude_corriere

int[]

seleziona se corriere NOT IN [corriere, corriere, ...]

invoice_number

string[]

seleziona se invoice_number IN [invoice_number, invoice_number, ...]

invoice_date_da

Y-m-d

Seleziona se invoice_date ≥ invoice_date_da

invoice_date_a

Y-m-d

Seleziona se invoice_date <= invoice_date_a

withDetails

1 | 0

Se 1 ritorna anche i dettagli dell'ordine

perPage

1...100

numero di risultati per pagina richiesti

page

int

numero di pagina richiesta

orderBy

id | client_id | order_ref | email | data_ordine | status | corriere | invoice_number | invoice_date

nome del campo su cui ordinare (default id)

order

ASC | DESC

verso dell'ordinamento (default DESC)

Codici di esempio

Recupera un ordine e dettagli

GET https://api.gsped.it/[ISTANZA]/Orders/[ID_ORDINE]

Recupera un ordine e i relativi dettagli da Gsped

Headers

Name
Type
Description

x-api-key*

String

APIKEY fornita da Gsped

Snippets codice di esempio

Caricamento ordini e dettagli

POST https://api.gsped.it/[ISTANZA]/Orders

Permette di caricare gli ordini ed i relativi dettagli su Gsped

Headers

Name
Type
Description

x-api-key*

String

APIKEY fornita da Gsped

Request Body

Name
Type
Description

client_id*

Int

Client ID Gsped

zip*

String

Zipcode Destinatario

city*

String

Città Destinatario

address*

String

Indirizzo Destinatario

name*

String

Nome Destinatario

order_ref*

String

Riferimento ordine

email*

String

Indirizzo email Destinatario

country*

String

Country code iso 2 char

province*

String

Sigla Provincia o Stato

insurance

Float

Valore assicurazione

cod

Float

Valore del contrasssegno

phone*

String

Numero di telefono

rows.description

String

Descrizione dettaglio ordine

warehouse

String

Magazzino

notes

String

Note ordine

rows.qty

Int

Quantità dettaglio

rows.sku

String

SKU dettaglio

rows.country_of_origin

String

Country code iso 2 char di origine della merce

invoice_date

String

Data della fattura dell'ordine

invoice_number

String

Numero della fattura dell'ordine

rows.hs_code

String

HS code dettaglio

rows.barcode_riga

String

Stringa barcode singolo item

rows.prezzo_singolo

String

Prezzo singolo item

rows.peso_riga

String

Peso singolo item

Snippets codice di esempio

Modifica ordini e dettagli di ordine esistente

PATCH https://api.gsped.it/[ISTANZA]/Orders/[ID_ORDINE]

Permette di modificare un ordine ed i relativi dettagli su Gsped

Headers

Name
Type
Description

x-api-key*

String

APIKEY fornita da Gsped

Request Body

Name
Type
Description

client_id*

Int

Client ID Gsped

name*

String

Nome Destinatario

order_ref*

String

Riferimento ordine

address*

String

Indirizzo Destinatario

cod

Float

Valore del contrasssegno

phone*

String

Numero di telefono

email*

String

Indirizzo email Destinatario

country*

String

Country code iso 2 char

province*

String

Sigla Provincia o Stato

zip*

String

Zipcode Destinatario

city*

String

Città Destinatario

rows.description

String

Descrizione dettaglio ordine

warehouse

String

Magazzino

notes

String

Note ordine

invoice_number

String

Numero della fattura dell'ordine

invoice_date

String

Data della fattura dell'ordine

insurance

Float

Valore assicurazione

rows.hs_code

String

HS code dettaglio

rows.qty

Int

Quantità dettaglio

rows.sku

String

SKU dettaglio

rows.country_of_origin

String

Country code iso 2 char di origine della merce

Snippets codice di esempio

Comportamento in caso l'ordine sia collegato ad una spedizione da confermare: se la spedizione è extraUE e il corriere supporta i CIN se il corriere supporta la shipmentPatch dei dati CIN si esegue l'aggiornamento sul corriere, altrimenti la spedizione verrà messa in errore in quanto dovrà essere rigenerata con i nuovi dati ordine.

Last updated

Was this helpful?