API

Obtener estadísticas de los canales de venta

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

Devuelve los ingresos, el número de pedidos y el ticket promedio por cada canal de ventas. En una sola solicitud se pueden obtener hasta dos periodos para comparar mes a mes. Los totales del periodo ya están calculados, y para los gráficos se devuelven solo las horas no vacías en UTC. Convierte estas horas al huso horario del usuario y agrúpalas por días o meses. Solo los pedidos completados se incluyen en los ingresos.

Autorización

api-token + language + role

Parámetros de consulta

date_creation_fromstring

Ejemplo: 01/08/2026

date_creation_tostring

Ejemplo: 31/08/2026

date_comparison_fromstring

Segundo período; vacío si no hay con qué comparar

Ejemplo: 01/07/2026

date_comparison_tostring

Ejemplo: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Método de entrega: courier o pickup

Valores:courierpickup

payment_statusstring (OrderPayment)

Estado de pago: no pagado, pendiente, pagado

Valores:not_paidwaitingpaid

operator_idinteger
downloadstring

Devuelve una tabla resumen del período A en formato CSV en lugar de JSON

Valores:yes

Ejemplo: yes

Respuestas

OK

object
statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpuede ser nulo

Ejemplo: 2026-08-01 00:00:00

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_creation_toobject (FilterDateTo)
valuestringpuede ser nulo

Ejemplo: 2026-08-31 23:59:59

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_creation_rangeobject (FilterDateRange)

Períodos predefinidos para el filtro de fecha; el límite inferior se calcula según la zona horaria del usuario. value — período correspondiente a los valores actuales de *_from y *_to; null — período personalizado. default — período que el servidor utiliza en la solicitud si no se especifican fechas: también se aplica al cargar la sección por primera vez y al restablecer el filtro. El límite superior del período siempre corresponde al día actual del usuario, por lo que option no lo incluye: no es necesario enviar *_to para un período predefinido, el servidor lo establece automáticamente. Si el período es mayor a un año, se recorta por el límite más reciente.

valuestring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

defaultstring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

typestringobligatorio

Ejemplo: select

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

optionarray of objectobligatorio
valuestring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

date_fromstringobligatorio

Ejemplo: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpuede ser nulo

Ejemplo: 2026-08-01 00:00:00

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_comparison_toobject (FilterDateTo)
valuestringpuede ser nulo

Ejemplo: 2026-08-31 23:59:59

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Períodos predefinidos para el filtro de fechas sin valor por defecto: default siempre es null.

valuestring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

defaultstring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

typestringobligatorio

Ejemplo: select

optionarray of objectobligatorio
valuestring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

date_fromstringobligatorio

Ejemplo: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

delivery_methodobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

payment_statusobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botón para descargar la selección: al hacer clic, envíe download=yes

valuestring

Ejemplo: Download

typestringobligatorio

Ejemplo: button_download_csv

periodsarray of object

Un elemento por período; el segundo, solo si se especifica un período de comparación

keystringobligatorio

a — período principal, b — período de comparación

Valores:ab

Ejemplo: a

date_fromstringobligatorio

Ejemplo: 01/08/2026

date_tostringobligatorio

Ejemplo: 31/08/2026

totalobject (SalesChannelsTotal) obligatorio

Totales del período por todos los canales

orders_countintegerobligatorio

Ejemplo: 4120

completed_countintegerobligatorio

Ejemplo: 3894

completed_percentnumberobligatorio

Ejemplo: 94.51

revenuenumberobligatorio

Ejemplo: 4361280

averagenumberobligatorio

Ejemplo: 1120

channelsarray of objectobligatorio

Un elemento por cada canal con pedidos, en un orden fijo. No existe un elemento "todos los canales": para esto está total.

platformstring (OrderPlatform) obligatorio

Plataforma de pedido

Valores:androidapifbiosvksite

orders_countintegerobligatorio

Ejemplo: 1810

orders_sharenumberobligatorio

Porcentaje de pedidos del período

Ejemplo: 43.93

completed_countintegerobligatorio

Ejemplo: 1702

completed_percentnumberobligatorio

Ejemplo: 94.03

revenuenumberobligatorio

Ejemplo: 1855180

revenue_sharenumberobligatorio

Porcentaje de participación en los ingresos del período

Ejemplo: 42.54

averagenumberobligatorio

Ingresos divididos por el número de pedidos completados

Ejemplo: 1090

deltaobject (SalesChannelsDelta) obligatoriopuede ser nulo

Comparación del canal con el mismo canal en el período B. null si el período B no está especificado.

revenue_absolutenumberobligatorio

Ejemplo: -120400

revenue_percentnumberobligatoriopuede ser nulo

null, si en el período B el canal no tuvo ingresos: no hay porcentaje de crecimiento desde cero

Ejemplo: -6.09

bucketsarray of objectobligatorio

Pedidos agrupados por horas; solo horas no vacías. Convierta la hora al huso horario del usuario y luego agrupe las horas en puntos del gráfico: gráfico lineal — por días o meses, gráfico de barras — por meses calendario. Sume count, completed_count y revenue; no promedie los valores medios.

datetimestringobligatorio

Hora a la que corresponden los pedidos, en UTC

Ejemplo: 2026-08-01 09:00:00

countintegerobligatorio

Ejemplo: 12

completed_countintegerobligatorio

Ejemplo: 11

revenuenumberobligatorio

Ejemplo: 12100