API

Ottenere statistiche sui canali di vendita

GET/api/crm/v2/sales_channelsv2
operationId: salesChannels.default

Restituisce il fatturato, il numero di ordini e lo scontrino medio per ciascun canale di vendita. In una richiesta vengono restituiti fino a due periodi per confrontare mese su mese. I totali del periodo sono già calcolati, mentre per i grafici vengono restituite solo le ore non vuote in UTC. Convertirle nel fuso orario dell’utente e raggrupparle per giorni o mesi. Nel fatturato sono inclusi solo gli ordini completati.

Autorizzazione

api-token + language + role

Parametri della richiesta

date_creation_fromstring

Esempio: 01/08/2026

date_creation_tostring

Esempio: 31/08/2026

date_comparison_fromstring

Secondo periodo; vuoto se non c'è nulla con cui confrontare

Esempio: 01/07/2026

date_comparison_tostring

Esempio: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Metodo di consegna: corriere o ritiro in sede

Valori:courierpickup

payment_statusstring (OrderPayment)

Stato del pagamento: non pagato, in attesa, pagato

Valori:not_paidwaitingpaid

operator_idinteger
downloadstring

Restituisce una tabella riepilogativa per il periodo A in formato CSV invece di JSON

Valori:yes

Esempio: yes

Risposte

OK

object
statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpuò essere nullo

Esempio: 2026-08-01 00:00:00

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_toobject (FilterDateTo)
valuestringpuò essere nullo

Esempio: 2026-08-31 23:59:59

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_rangeobject (FilterDateRange)

Periodi predefiniti per il filtro data; il limite inferiore è calcolato nel fuso orario dell’utente. value indica il periodo corrispondente agli attuali *_from e *_to; null indica un periodo personalizzato. default è il periodo che il server inserisce nella richiesta senza date: viene applicato al primo caricamento della sezione e al reset. Il limite superiore del periodo corrisponde sempre al giorno attuale dell’utente, quindi option non lo include: non è necessario trasmettere *_to per un periodo predefinito, il server lo imposta automaticamente. Un periodo superiore a un anno viene troncato dal lato più recente.

valuestring (DateRange) può essere nullo

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

defaultstring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

typestringobbligatorio

Esempio: select

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

optionarray of objectobbligatorio
valuestring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

date_fromstringobbligatorio

Esempio: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpuò essere nullo

Esempio: 2026-08-01 00:00:00

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_comparison_toobject (FilterDateTo)
valuestringpuò essere nullo

Esempio: 2026-08-31 23:59:59

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Periodi predefiniti per il filtro delle date senza valore predefinito: default è sempre uguale a null.

valuestring (DateRange) può essere nullo

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

defaultstring (DateRange) può essere nullo

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

typestringobbligatorio

Esempio: select

optionarray of objectobbligatorio
valuestring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

date_fromstringobbligatorio

Esempio: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

delivery_methodobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

payment_statusobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

downloadobject (FilterButtonDownloadCsv)

Pulsante di download della selezione: al clic, passa download=yes

valuestring

Esempio: Download

typestringobbligatorio

Esempio: button_download_csv

periodsarray of object

Un elemento per periodo; il secondo solo se è specificato un periodo di confronto

keystringobbligatorio

a — periodo principale, b — periodo di confronto

Valori:ab

Esempio: a

date_fromstringobbligatorio

Esempio: 01/08/2026

date_tostringobbligatorio

Esempio: 31/08/2026

totalobject (SalesChannelsTotal) obbligatorio

Totali del periodo per tutti i canali

orders_countintegerobbligatorio

Esempio: 4120

completed_countintegerobbligatorio

Esempio: 3894

completed_percentnumberobbligatorio

Esempio: 94.51

revenuenumberobbligatorio

Esempio: 4361280

averagenumberobbligatorio

Esempio: 1120

channelsarray of objectobbligatorio

Un elemento per ciascun canale con ordini, in ordine fisso. L'elemento "tutti i canali" non è presente: per questo c'è total.

platformstring (OrderPlatform) obbligatorio

Piattaforma di ordinazione

Valori:androidapifbiosvksite

orders_countintegerobbligatorio

Esempio: 1810

orders_sharenumberobbligatorio

Quota ordini del periodo in percentuale

Esempio: 43.93

completed_countintegerobbligatorio

Esempio: 1702

completed_percentnumberobbligatorio

Esempio: 94.03

revenuenumberobbligatorio

Esempio: 1855180

revenue_sharenumberobbligatorio

Quota percentuale dei ricavi per il periodo

Esempio: 42.54

averagenumberobbligatorio

Ricavo diviso per il numero di ordini completati

Esempio: 1090

deltaobject (SalesChannelsDelta) obbligatoriopuò essere nullo

Confronto del canale con lo stesso canale nel periodo B. null se il periodo B non è specificato.

revenue_absolutenumberobbligatorio

Esempio: -120400

revenue_percentnumberobbligatoriopuò essere nullo

null, se nel periodo B il canale non ha avuto ricavi: non esiste una crescita percentuale da zero

Esempio: -6.09

bucketsarray of objectobbligatorio

Ordini raggruppati per ora; solo le ore non vuote. Converti l'orario nel fuso orario dell'utente, poi aggrega le ore nei punti del grafico: grafico lineare — per giorni o mesi, grafico a barre — per mesi di calendario. Somma count, completed_count e revenue; non calcolare la media dei valori medi.

datetimestringobbligatorio

Ora a cui si riferiscono gli ordini, in UTC

Esempio: 2026-08-01 09:00:00

countintegerobbligatorio

Esempio: 12

completed_countintegerobbligatorio

Esempio: 11

revenuenumberobbligatorio

Esempio: 12100