Overview Persone Aziende Campi custom Azioni Carrelli Corsi edizioni Tags Stati trattativa Sms Esempi

Hai dei dubbi o delle domande ? Non esitare a contattarci, inviandoci una email a support@brainlead.it

Carrelli

Sommario

GET /carts/
POST /carts/add
POST /carts/{:id}/update
DELETE /carts/{:id}/delete

GET /carts/

Invia una chiamata GET a questo indirizzo per ricercare i CARRELLI in archivio.
La lista dei carrelli verrà ordinato prima per data e poi per cognome e nome della persona.

Richiesta

Parametro	Tipo	Descrizione
`page`	integer	Pagina dei risultati che si vuole visualizzare. Per ogni pagina vengono restituiti un massimo di 30 records.
`query`	string	Testo di ricerca. Per ogni parte del testo, verrà ricercata l'eventuale corrispondenza nei campi: nome, cognome, email della persona associata al carrello e l'id sorgente esterna dello stesso.
`emails`	string	Emails. Per ogni email inserita, verrà ricercata l'eventuale presenza nella scheda persona associata al corrello. Nel caso si vogliano ricercare più email, queste devono essere separate dal carattere ",". La ricerca di più email verrà effettuata applicando la logica OR.

Risposta

La chiamata restituirà un array con i carrelli che sono stati trovati utilizzando i parametri impostati nella chiamata.
Per ogni carrello verrà fornito un tracciato con le seguenti informazioni:

Parametro	Tipo	Descrizione
`id`	integer	Id del carrello.
`shop_url`	url	Url dell'eshop (lunghezza 0-100).
`date`	datetime	Data e ora dell'ultima modifica al carrello.
`status`	integer	Stato del carrello. Il parametro indica lo stato del carrello e può assumere uno di questi valori: `0` Carrello `1` Carrello abbandonato `2` Ordine `3` Ordine reso `4` Ordine cancellato
`order_date`	datetime	Data e ora dell'ordine.
`order_number`	string	Numero dell'ordine (lunghezza 0-15).
`order_status`	string	Stato dell'ordine (lunghezza 0-100).
`customer_id`	integer	Id della persona associata al carrello.
`customer_name`	string	Nome della persona associata al carrello (lunghezza 0-100).
`customer_surname`	string	Cognome della persona associata al carrello (lunghezza 0-100).
`customer_email` `customer_email_work` `customer_email_private`	email	Email associata alla persona che ha sviluppato il carrello (lunghezza 0-100). Il parametro indica la tipologia di email associata alla persona: `customer_email` Altro `customer_email_work` Lavoro `customer_email_private` Privata Possono essere presenti più tipologie di email associate alla stessa persona.
`products`	array	Prodotti in carrello. Per ogni prodotto in carrello verranno indicati i seguenti campi: `code` Codice/SKU del prodotto (string - lunghezza 0-50) `brand` Brand associato al prodotto (string - lunghezza 0-100) `category` Categorie del prodotto (array - contiene l'albero delle categorie abbinate al prodotto) `name` Nome del prodotto (string - lunghezza 0-200) `img` Immagine del prodotto (url) `description` Descrizione del prodotto (string - lunghezza 0-5000) `url` Url del prodotto sull'eshop (url) `qta` Quantità del prodotto (integer) `total` Totale iva compresa del prodotto acquistato (money)
`external_id`	string	Id sorgente esterna a cui è associato il carrello. Se il parametro contiene una stringa vuota, vuol dire che il carrello al momento non ha nessun Id sorgente esterna associato. Se impostato dev'essere univoco per il carrello/ordine e mantenere sempre lo stesso valore.

POST /carts/add

Invia una chiamata POST a questo indirizzo per creare un nuovo CARRELLO.

Richiesta

Parametro	Tipo	Descrizione
`shop_url`	url (Obbligatorio)	Url dell'eshop (lunghezza 0-100). Il parametro è obbligatorio e deve essere presente nella chiamata.
`date`	datetime (Obbligatorio)	Data e ora dell'ultima modifica al carrello. Il parametro è obbligatorio e deve essere presente nella chiamata.
`status`	integer (Obbligatorio)	Stato del carrello. Questo campo può assumere uno tra i seguenti valori: `0` Carrello `1` Carrello abbandonato `2` Ordine `3` Ordine reso `4` Ordine cancellato Il parametro è obbligatorio e deve essere presente nella chiamata.
`order_date`	datetime	Data e ora dell'ordine. Il parametro diventa obbligatorio e deve essere presente nella chiamata, se il valore contenuto nel campo `status` è maggiore di 1.
`order_number`	string	Numero dell'ordine (lunghezza 0-15). Il parametro diventa obbligatorio e deve essere presente nella chiamata, se il valore contenuto nel campo `status` è maggiore di 1.
`order_status`	string	Stato dell'ordine (lunghezza 0-100). Il parametro diventa obbligatorio e deve essere presente nella chiamata, se il valore contenuto nel campo `status` è maggiore di 1.
`order_external_id`	string	Id sorgente esterna a cui associare l'ordine (lunghezza 0-50). Se il parametro contiene una stringa vuota, vuol dire che l'ordine al momento non ha nessun Id sorgente esterna associato. Se impostato dev'essere univoco per il carrello/ordine e mantenere sempre lo stesso valore.
`customer_id`	integer	Id persona associata al carrello.
`customer_name`	string	Nome del cliente (lunghezza 0-100).
`customer_surname`	string	Cognome del cliente (lunghezza 0-100).
`customer_email`	email (Obbligatorio)	Email associata al cliente (lunghezza 0-100). Il parametro è obbligatorio e deve essere presente nella chiamata.
`customer_phone`	string	Telefono associato al cliente (lunghezza 0-50).
`customer_custom_field_ID`	string boolean numeric date enum money	sostituisci ID con l'ID campo custom, es: customer_custom_field_123.
`customer_external_id`	string	Id sorgente esterna a cui associare il cliente (lunghezza 0-50). Se il parametro contiene una stringa vuota, vuol dire che il cliente al momento non ha nessun Id sorgente esterna associato.
`billing_address`	string	Via dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-255). Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città diventa obbligatorio.
`billing_city`	string	Città dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-100). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_state`	string	Provincia dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_zipcode`	string	CAP dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_region`	string	Regione dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_country`	string	Nazione dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-50). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`payment_method`	string	Modalità di pagamento utilizzata per l'acquisto (lunghezza 0-255).
`shipping_address`	string	Via dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-255). Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città diventa obbligatorio.
`shipping_city`	string	Città dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-100). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_state`	string	Provincia dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_zipcode`	string	CAP dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_region`	string	Regione dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_country`	string	Nazione dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-50). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_method`	string	Modalità di spedizione utilizzata per l'acquisto (lunghezza 0-255).
`products`	array (Obbligatorio)	Prodotti in carrello. Per ogni prodotto in carrello dovranno essere indicati e valorizzati i seguenti campi: `code` Codice/SKU del prodotto (string - lunghezza 0-50) `brand` Brand associato al prodotto (string - lunghezza 0-100) `category` Categorie del prodotto (array - contiene l'albero delle categorie abbinate al prodotto) `name` Nome del prodotto (Obbligatorio - string - lunghezza 0-200) `img` Immagine del prodotto (url) `description` Descrizione del prodotto (string - lunghezza 0-5000) `url` Url del prodotto sull'eshop (url) `external_id` Id sorgente esterna abbinata al prodotto (string - lunghezza 0-50) `qta` Quantità del prodotto (Obbligatorio - integer) `total` Totale iva compresa del prodotto acquistato (Obbligatorio - money) Il parametro è obbligatorio e deve essere presente nella chiamata.
`coupons`	array	Coupons utilizzati per l'acquisto.
`transaction_id`	string	Riferimento transazione utilizzata per l'acquisto (lunghezza 0-100).
`total_tax`	money	Totale tasse comprensivo di IVA abbinato all'ordine. Se non valorizzato verrà attribuito il valore 0.
`total_discount`	money	Totale sconto comprensivo di IVA abbinato all'ordine. Se non valorizzato verrà attribuito il valore 0.
`total_shipping`	money	Totale spese di spedizione comprensive di IVA abbinate all'ordine. Se non valorizzato verrà attribuito il valore 0.
`currency`	iso code	Valuta utilizzata per l'ordine. Se non valorizzato verrà attribuito il valore 'EUR'.
`external_id`	string	Id sorgente esterna a cui associare il carrello. Se il parametro contiene una stringa vuota, vuol dire che il carrello al momento non ha nessun Id sorgente esterna associato. Se impostato dev'essere univoco per il carrello/ordine e mantenere sempre lo stesso valore.

Risposta

Parametro	Tipo	Descrizione
`id`	integer	Id del nuovo carrello.
`add`	boolean	Contiene true se la chiamata ha prodotto un nuovo carrello, altrimenti sarà false ovvero la chiamata ha aggiornato un carrello già presente in db.

POST /carts/{:id}/update

Invia una chiamata POST a questo indirizzo per modificare un CARRELLO.
Nella chiamata sostituire {:id} con l'id carrello da modificare.

Richiesta

Parametro	Tipo	Descrizione
`shop_url`	url (Obbligatorio)	Url dell'eshop (lunghezza 0-100). Il parametro è obbligatorio e deve essere presente nella chiamata.
`date`	datetime (Obbligatorio)	Data e ora dell'ultima modifica al carrello. Il parametro è obbligatorio e deve essere presente nella chiamata.
`status`	integer (Obbligatorio)	Stato del carrello. Questo campo può assumere uno tra i seguenti valori: `0` Carrello `1` Carrello abbandonato `2` Ordine `3` Ordine reso `4` Ordine cancellato Il parametro è obbligatorio e deve essere presente nella chiamata.
`order_date`	datetime	Data e ora dell'ordine. Il parametro diventa obbligatorio e deve essere presente nella chiamata, se il valore contenuto nel campo `status` è maggiore di 1.
`order_number`	string	Numero dell'ordine (lunghezza 0-15). Il parametro diventa obbligatorio e deve essere presente nella chiamata, se il valore contenuto nel campo `status` è maggiore di 1.
`order_status`	string	Stato dell'ordine (lunghezza 0-100). Il parametro diventa obbligatorio e deve essere presente nella chiamata, se il valore contenuto nel campo `status` è maggiore di 1.
`order_external_id`	string	Id sorgente esterna a cui associare l'ordine (lunghezza 0-50). Se il parametro contiene una stringa vuota, vuol dire che l'ordine al momento non ha nessun Id sorgente esterna associato. Se impostato dev'essere univoco per il carrello/ordine e mantenere sempre lo stesso valore.
`customer_id`	integer	Id persona associata al carrello.
`customer_name`	string	Nome del cliente (lunghezza 0-100).
`customer_surname`	string	Cognome del cliente (lunghezza 0-100).
`customer_email`	email (Obbligatorio)	Email associata al cliente (lunghezza 0-100). Il parametro è obbligatorio e deve essere presente nella chiamata.
`customer_phone`	string	Telefono associato al cliente (lunghezza 0-50).
`customer_custom_field_ID`	string boolean numeric date enum money	sostituisci ID con l'ID campo custom, es: customer_custom_field_123.
`customer_external_id`	string	Id sorgente esterna a cui associare il cliente (lunghezza 0-50). Se il parametro contiene una stringa vuota, vuol dire che il cliente al momento non ha nessun Id sorgente esterna associato.
`billing_address`	string	Via dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-255). Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città diventa obbligatorio.
`billing_city`	string	Città dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-100). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_state`	string	Provincia dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_zipcode`	string	CAP dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_region`	string	Regione dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`billing_country`	string	Nazione dell'indirizzo di fatturazione associato all'acquisto (lunghezza 0-50). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`payment_method`	string	Modalità di pagamento utilizzata per l'acquisto (lunghezza 0-255).
`shipping_address`	string	Via dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-255). Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città diventa obbligatorio.
`shipping_city`	string	Città dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-100). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_state`	string	Provincia dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_zipcode`	string	CAP dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_region`	string	Regione dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-45). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_country`	string	Nazione dell'indirizzo di spedizione associato all'acquisto (lunghezza 0-50). Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia, deve essere valorizzato.
`shipping_method`	string	Modalità di spedizione utilizzata per l'acquisto (lunghezza 0-255).
`products`	array (Obbligatorio)	Prodotti in carrello. Per ogni prodotto in carrello dovranno essere indicati e valorizzati i seguenti campi: `code` Codice/SKU del prodotto (string - lunghezza 0-50) `brand` Brand associato al prodotto (string - lunghezza 0-100) `category` Categorie del prodotto (array - contiene l'albero delle categorie abbinate al prodotto) `name` Nome del prodotto (Obbligatorio - string - lunghezza 0-200) `img` Immagine del prodotto (url) `description` Descrizione del prodotto (string - lunghezza 0-5000) `url` Url del prodotto sull'eshop (url) `external_id` Id sorgente esterna abbinata al prodotto (string - lunghezza 0-50) `qta` Quantità del prodotto (Obbligatorio - integer) `total` Totale iva compresa del prodotto acquistato (Obbligatorio - money) Il parametro è obbligatorio e deve essere presente nella chiamata.
`coupons`	array	Coupons utilizzati per l'acquisto.
`transaction_id`	string	Riferimento transazione utilizzata per l'acquisto (lunghezza 0-100).
`total_tax`	money	Totale tasse comprensivo di IVA abbinato all'ordine. Se non valorizzato verrà attribuito il valore 0.
`total_discount`	money	Totale sconto comprensivo di IVA abbinato all'ordine. Se non valorizzato verrà attribuito il valore 0.
`total_shipping`	money	Totale spese di spedizione comprensive di IVA abbinate all'ordine. Se non valorizzato verrà attribuito il valore 0.
`currency`	iso code	Valuta utilizzata per l'ordine. Se non valorizzato verrà attribuito il valore 'EUR'.
`external_id`	string	Id sorgente esterna a cui associare il carrello. Se il parametro contiene una stringa vuota, vuol dire che il carrello al momento non ha nessun Id sorgente esterna associato. Se impostato dev'essere univoco per il carrello/ordine e mantenere sempre lo stesso valore.

Risposta

Parametro	Tipo	Descrizione
`updated`	boolean	Contiene true se la chiamata ha prodotto un aggiornamento del carrello, altrimenti sarà false.

DELETE /carts/{:id}/delete

Invia una chiamata DELETE a questo indirizzo per eliminare un CARRELLO.
Nella chiamata sostituire {:id} con l'id carrello da eliminare.

Risposta

Parametro	Tipo	Descrizione
`deleted`	boolean	Contiene true se l'eliminazione è andata a buon fine.