get_order_items
Questa chiamata elenca tutti gli ordini che soddisfano le condizioni di ricerca.
La struttura della chiamata è divisa in due
- search: nella quale vanno inseriti i parametri di ricerca.
Nota:I parametri di ricerca sono tutti in AND tra di loro, quindi definire ad esempio un id_order produrrà al massimo un risultato. - display: nella quale si definisce cosa si vuol vedere come output della chiamata. Tutti i campi sono visibili di default.
Chiamata parametri:
Parametro |
Obbligatorio |
Default |
Note |
uid |
si |
Id cliente |
|
pid |
si |
Id Portale |
|
lid |
si |
id Lingua |
|
key |
si |
Codice di autenticazione |
|
api_version |
si |
Versione API. |
|
request |
si |
Nome della funzione richiesta |
|
search |
si |
Nodo della sezione di ricerca |
|
id_order |
no |
null |
cerca un ordine per ID |
from |
no |
null |
Cerca i prodotti creati dalla data indicata |
to |
no |
null |
Cerca i prodotti creati fino alla data indicata |
row_max |
no |
50 |
Indica il numero massimo di righe che la ricerca potrà mostrare |
page |
no |
1 |
indica quale pagina visualizzare nel caso in cui ci fossero più dei prodotti indicati in row_max |
display |
si |
Nodo della sezione filtro in output |
|
id_order_store |
no |
true |
id ordine Store. Questo Id è lo stesso visibile nello storico ordini dello store |
id_catalog |
no |
true |
id catalogo |
catalog_name |
no |
true |
nome catalogo |
id_supplier |
no |
true |
id fornitore store |
speed_shipping |
no |
true |
Velocità di consegna del fornitore
|
id_product |
no |
true |
id prodotto |
reference |
no |
true |
definizione referenza da casa madre |
product_name |
no |
true |
nome prodotto |
ean |
no |
true |
ean |
qty_reserved |
no |
true |
quantità Riservata dallo store |
qty_sent |
no |
true |
quantità effettivamente inviata |
retail_price |
no |
true |
prezzo listino |
discount |
no |
true |
sconto |
price |
no |
true |
prezzo di vendita |
extra_discount |
no |
true |
sconto extra |
net_price |
no |
true |
prezzo netto finale |
user_id_order |
no |
true |
id ordine utente finale |
user_id_user |
no |
true |
id utente finale |
user_company_name |
no |
true |
titolo utente o ragione sociale |
user_first_name |
no |
true |
nome |
user_last_name |
no |
true |
cognome |
user_address |
no |
true |
indirizzo |
user_city |
no |
true |
città |
user_country |
no |
true |
provincia |
user_zipcode |
no |
true |
cap |
user_state |
no |
true |
nazione |
user_phone |
no |
true |
telefono |
user_mobile |
no |
true |
cellulare |
user_mail |
no |
true |
|
user_retail_price |
no |
true |
prezzo di vendita store |
user_discount |
no |
true |
sconto cliente |
user_price |
no |
true |
prezzo finale |
user_cod |
no |
0 |
Pagamento in contrassegno (cod: Cache on Delivery ). Due soli valori ammessi:
Default : 0 |
user_note |
no |
true |
notizie dal cliente |
internal_note |
no |
true |
notizie interne allo store |
order_status |
no |
true |
stato ordine |
order_tracking_company |
no |
true |
codice società logistica |
order_tracking_number |
no |
true |
tracking nuber spedizione |
created_at |
no |
true |
data creazione ordine |
last_update |
no |
true |
ultima modifica |
Risposta parametri:
Parametro |
Sempre Presente |
Note |
success |
si |
true o false, indica se l'operazione ha avuto buon esito o meno |
rc |
si |
return code. |
message |
si |
Messaggio di errore |
num_rows |
si ( se rc != -4 ) |
numero di righe ottenute dalla richiesta |
rows |
si ( se rc != -4 ) |
Nodo della sezione dati |
id_order_strore |
no |
id ordine store |
id_catalog |
no |
id catalogo |
catalog_name |
no |
nome catalogo |
id_supplier |
no |
id fornitore |
speed_shipping |
no |
Velocità di consegna del fornitore
|
id_product |
no |
id prodotto |
reference |
no |
definizione referenza da casa madre |
product_name |
no |
nome prodotto |
ean |
no |
ean |
qty_reserved |
no |
quantità Riservata |
qty_sent |
no |
quantità effettivamente inviata |
qty_sent |
no |
quantità effettivamente inviata |
retail_price |
no |
prezzo listino |
discount |
no |
sconto |
price |
no |
prezzo di vendita |
extra_discount |
no |
sconto extra |
net_price |
no |
prezzo netto finale |
user_id_order |
no |
id ordine utente finale |
user_id_user |
no |
id utente finale |
user_company_name |
no |
titolo utente o ragione sociale |
user_first_name |
no |
nome |
user_last_name |
no |
cognome |
user_address |
no |
indirizzo |
user_city |
no |
città |
user_country |
no |
provincia |
user_zipcode |
no |
cap |
user_state |
no |
nazione |
user_phone |
no |
telefono |
user_mobile |
no |
cellulare |
user_mail |
no |
|
user_retail_price |
no |
prezzo di vendita store |
user_discount |
no |
sconto cliente |
user_price |
no |
prezzo finale |
user_cod |
no |
Pagamento in contrassegno (cod: Cache on Delivery ). Due soli valori ammessi:
Default : 0 |
user_note |
no |
notizie dal cliente |
internal_note |
no |
notizie interne allo store |
order_status |
no |
stato ordine 0 - New 1 - Ready 2 - Logistic Locked 3 - Complete. Order Shipped 4 - Complete. Order Shipped Zero Items |
order_tracking_company |
no |
codice società logistica |
order_tracking_number |
no |
tracking nuber spedizione |
created_at |
no |
data creazione ordine |
last_update |
no |
ultima modifica |
Questo parte del messaggio può avere come messaggi d'errore
- -2 Access Denied
- -4 Fatal Error: There was an internal Error. Please retry or contact webmaster@wwt.it
- -14 Unable to proceed. User does not have permission to perform this action
Nel caso di errori -2, -4 e -14, non sarà presente il campo items e quindi neppure il dettaglio dei singoli messaggi.
Struttura Chiamate JSON
{ "uid" : "12345", "pid" : "2", "lid" : "1", "key” : "VtKpudWnzRBioQeBKQXPBdSpamppUTw8", "api_version" : "1.0.0", "request": "get_order_items", "search": { "from": "2013-09-19 00:00:00", "to": "2013-09-21 23:59:59", "status": "*", "row_max": 3, "page": 2 }, "display": { "id_order_store": true, "id_catalog": true, "id_supplier": true, "speed_shipping": true, "catalog_name": true, "catalog_name": true, "catalog_name": true, "id_product": true, "reference": true, "product_name": true, "ean": true, "qty_reserved": true, "qty_sent": true, "retail_price": true, "discount": true, "price": true, "extra_discount": true, "net_price": true, "user_id_order": true, "user_id_user": true, "user_company_name": true, "user_first_name": true, "user_last_name": true, "user_address": true, "user_city": true, "user_country": true, "user_zipcode": true, "user_state": true, "user_phone": true, "user_mobile": true, "user_mail": true, "user_retail_price": true, "user_discount": true, "user_price": true, "user_cod": true, "user_note": true, "internal_note": true, "order_status": true, "order_tracking_company": true, "order_tracking_number": true, "created_at": true, "last_update": true } } |
Struttura Chiamata php
$data = array( "uid" => 12345, "pid" => 2, "lid" => 1, "key" => "VtKpudWnzRBioQeBKQXPBdSpamppUTw8", "api_version" => "1.0.0", "request" => "get_order_items", "search" => array( "from" => "2013-09-19 00:00:00", "to" => "2013-09-21 23:59:59", "status" => "*", "row_max" => 3, "page" => 1, ), "display" => array( "id_order_store" => true, "id_catalog" => true, "catalog_name" => true, "id_supplier" => true, "speed_shipping" => true, "id_product" => true, "reference" => true, "product_name" => true, "ean" => true, "qty_reserved" => true, "qty_sent" => true, "retail_price" => true, "discount" => true, "price" => true, "user_id_order" => true, "user_id_user" => true, "user_company_name" => true, "user_first_name" => true, "user_last_name" => true, "user_address" => true, "user_city" => true, "user_country" => true, "user_zipcode" => true, "user_state" => true, "user_phone" => true, "user_mobile" => true, "user_mail" => true, "user_retail_price" => true, "user_discount" => true, "user_price" => true, "user_cod" => true, "user_note" => true, "internal_note" => true, "order_status" => true, "order_tracking_company" => true, "order_tracking_number" => true, "created_at" => true, "last_update" => true )
); $data = array('data' => json_encode($data)); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://dev.dropshippingb2b.com/api/"); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER,FALSE); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST,2); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); $ce = curl_exec($ch); // in $ce la risposta alla chiamata echo $ce; curl_close($ch); |
Esempio di Risposta positiva con nessun record
{ "success": true, "rc": 0, "message": "", "num_rows":0 } |
Esempio di Risposta positiva con più record
{ "success": true, "rc": 0, "message": "", "num_rows": 3, "insert_id": 0, "rows": [{ "id_order": "4", "id_order_store": "15", "id_catalog": "277", "catalog_name": "TIMEX", "id_supplier": 18, "speed_shipping": 1, "id_product": "110032", "reference": "T5K647", "product_name": "Timex Timex Marathon T5K647", "ean": "", "qty_reserved": "1", "qty_sent": "0", "retail_price": "39.00", "discount": "65.00", "price": "13.65", "user_id_order": "22", "user_id_user": "33", "user_company_name": "Ms", "user_first_name": "Matilda", "user_last_name": "Dale", "user_address": "10 Horner Street", "user_city": "Akron", "user_country": "OH", "user_zipcode": "44307", "user_state": "United States", "user_phone": "330-977-0601", "user_mobile": "330-977-0602", "user_mail": "MatildaDale@rhyta.com", "user_retail_price": "1000.00", "user_discount": "50.30", "user_price": "497.00", "user_cod": "1", "user_note": "dGVzdG8gY2xpZW50ZQ==", "internal_note": "dGVzdG8gZXNlcmNlbnRl", "order_status": "0", "order_tracking_company": "", "order_tracking_number": "", "created_at": "2013-09-20 12:21:06", "last_update": "2013-09-20 12:21:06" }, { "id_order": "5", "id_order_store": "15", "id_catalog": "277", "catalog_name": "TIMEX", "id_supplier": 18, "speed_shipping": 1, "id_product": "110032", "reference": "T5K647", "product_name": "Timex Timex Marathon T5K647", "ean": "", "qty_reserved": "1", "qty_sent": "0", "retail_price": "39.00", "discount": "65.00", "price": "13.65", "user_id_order": "22", "user_id_user": "33", "user_company_name": "Ms", "user_first_name": "Matilda", "user_last_name": "Dale", "user_address": "10 Horner Street", "user_city": "Akron", "user_country": "OH", "user_zipcode": "44307", "user_state": "United States", "user_phone": "330-977-0601", "user_mobile": "330-977-0602", "user_mail": "MatildaDale@rhyta.com", "user_retail_price": "1000.00", "user_discount": "50.30", "user_price": "497.00", "user_cod": "1", "user_note": "dGVzdG8gY2xpZW50ZQ==", "internal_note": "dGVzdG8gZXNlcmNlbnRl", "order_status": "0", "order_tracking_company": "", "order_tracking_number": "", "created_at": "2013-09-20 12:21:06", "last_update": "2013-09-20 12:21:06" }, { "id_order": "6", "id_order_supplier": "15", "id_catalog": "562", "catalog_name": "TISSOT", "id_supplier": 18, "speed_shipping": 1, "id_product": "107825", "reference": "T0064241605300", "product_name": "TISSOT - LE LOCLE U AUTO RIS.CAR. C.NER", "ean": "7611608226476", "qty_reserved": "1", "qty_sent": "0", "retail_price": "1035.00", "discount": "40.00", "price": "621.00", "user_id_order": "22", "user_id_user": "33", "user_company_name": "Mr.", "user_first_name": "Arabella", "user_last_name": "Palermo", "user_address": "Bayreuther Strasse 14", "user_city": "Offenbach", "user_country": "am", "user_zipcode": "63073", "user_state": "Germany", "user_phone": "069 82 66 04", "user_mobile": "069 82 66 07", "user_mail": "ArabellaPalermo@dayrep.de", "user_retail_price": "1000.00", "user_discount": "50.30", "user_price": "497.00", "user_cod": "1", "user_note": "dGVzdG8gY2xpZW50ZQ==", "internal_note": "dGVzdG8gZXNlcmNlbnRl", "order_status": "0", "order_tracking_company": "", "order_tracking_number": "", "created_at": "2013-09-20 12:21:06", "last_update": "2013-09-20 12:21:06" }] } |
Una risposta Json negativa possibile:
{ "success": false, "rc": -4, "message”: "Fatal Error: There was an internal Error. Please retry or contact webmaster@wwt.it" } |
Created with the Personal Edition of HelpNDoc: Generate Kindle eBooks with ease