@ deliverart/ sdk- js- stats

交付艺术JavaScript SDK的统计和分析包.

安装

npm install @deliverart/sdk-js-stats @deliverart/sdk-js-core
# or
pnpm add @deliverart/sdk-js-stats @deliverart/sdk-js-core
# or
yarn add @deliverart/sdk-js-stats @deliverart/sdk-js-core

此套件导出什么

该套件目前每天揭露五个统计家庭:

• CustomerDailyStats
• CourierDailyStats
• DeliveryDailyStats
• MenuItemDailyStats
• OrderDailyStats

也暴露出前端准备的分析端点:

• CustomerStatsOverviewResponse
• DeliveryStatsOverviewResponse
• DeliveryZoneStatsResponse

每个家庭包括:

• a Zod 模型计划并推断出类型Script
• a 详细资源的IRI 计划/类型
• 请求收集分类和细节终点
• 现有销售点范围收集请求

所有日常桶都使用本地日销售点,暴露为 YYYY-MM-DD。 。 。 .

现有请求

日统计

• GetCourierDailyStats
• GetCourierDailyStatsDetails
• GetCourierDailyStatsFromPointOfSale
• GetCourierDailyStatsFromUser

客户日统计

• GetCustomerDailyStats
• GetCustomerDailyStatsDetails
• GetCustomerDailyStatsFromPointOfSale
• GetCustomerDailyStatsFromCustomer
• GetCustomerStatsOverview

每日发送数据

• GetDeliveryDailyStats
• GetDeliveryDailyStatsDetails
• GetDeliveryDailyStatsFromPointOfSale

交付统计概览

• GetDeliveryStatsOverviewFromPointOfSale

交付区分析

• GetDeliveryZoneStatsFromPointOfSale

每日统计顺序

• GetOrderDailyStats
• GetOrderDailyStatsDetails
• GetOrderDailyStatsFromPointOfSale

菜单项每日统计

• GetMenuItemDailyStats
• GetMenuItemDailyStatsDetails
• GetMenuItemDailyStatsFromPointOfSale
• GetMenuItemDailyStatsFromMenuItem

查询支持

软件包将当前API支持的过滤器的输入查询方案曝光:

• 维度的精确过滤器,例如 pointOfSale, (中文(简体) ), courierUser, (中文(简体) ), menuItem, (中文(简体) ), salesMode, (中文(简体) ), type, (中文(简体) ), orderType, (中文(简体) ), source, (中文(简体) ), partner, (中文(简体) ), paymentMethod,以及 planningMode
• 维度的精确过滤器,例如 customer, (中文(简体) ), pointOfSale, (中文(简体) ), courierUser, (中文(简体) ), menuItem, (中文(简体) ), salesMode, (中文(简体) ), type, (中文(简体) ), orderType, (中文(简体) ), source, (中文(简体) ), partner, (中文(简体) ), paymentMethod,以及 planningMode
• 日期过滤器, 如 day[before], (中文(简体) ), day[strictly_after], (中文(简体) ), calculatedAt[after]
• 数字 KPI 的筛选范围, 如 ordersCount[gte], (中文(简体) ), deliveryOrdersCount[lte], (中文(简体) ), totalAmount[gt]
• 排序通过 order[...]
• 通过 page, (中文(简体) ), itemsPerPage,以及 pagination

用法实例

每日发送者名单

import { GetCourierDailyStats } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetCourierDailyStats({
    query: {
      source: 'application',
      'day[after]': '2026-04-01',
      'order[day]': 'desc',
    },
  }),
)

一个客户的每日统计表

import { GetCustomerDailyStatsFromCustomer } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetCustomerDailyStatsFromCustomer('customer-123', {
    query: {
      source: 'application',
      'day[after]': '2026-04-01',
      'order[totalAmount]': 'desc',
    },
  }),
)

列出单点销售的每日数据

import { GetDeliveryDailyStatsFromPointOfSale } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetDeliveryDailyStatsFromPointOfSale('pos-123', {
    query: {
      planningMode: 'PLANNED',
      'totalDelaySeconds[gt]': 0,
      'day[after]': '2026-04-01',
    },
  }),
)

每日数据列表顺序

import { GetOrderDailyStats } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetOrderDailyStats({
    query: {
      type: 'delivery',
      paymentMethod: 'credit_card',
      'totalAmount[gte]': 100,
      'order[totalAmount]': 'desc',
    },
  }),
)

列出一个销售点的菜单项

import { GetMenuItemDailyStatsFromPointOfSale } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetMenuItemDailyStatsFromPointOfSale('pos-123', {
    query: {
      orderType: 'delivery',
      'quantitySold[gte]': 10,
      'order[totalAmount]': 'desc',
    },
  }),
)

每天拿一个统计桶

import {
  GetCustomerDailyStatsDetails,
  GetCourierDailyStatsDetails,
  GetDeliveryDailyStatsDetails,
  GetMenuItemDailyStatsDetails,
  GetOrderDailyStatsDetails,
} from '@deliverart/sdk-js-stats'

await sdk.call(new GetCustomerDailyStatsDetails('customer-stats-uuid'))
await sdk.call(new GetCourierDailyStatsDetails('courier-stats-uuid'))
await sdk.call(new GetDeliveryDailyStatsDetails('delivery-stats-uuid'))
await sdk.call(new GetMenuItemDailyStatsDetails('menu-item-stats-uuid'))
await sdk.call(new GetOrderDailyStatsDetails('order-stats-uuid'))

获取客户数据概览

import { GetCustomerStatsOverview } from '@deliverart/sdk-js-stats'

const overview = await sdk.call(
  new GetCustomerStatsOverview('customer-123', {
    query: {
      'day[after]': '2026-04-01',
      source: 'application',
    },
  }),
)

获取一个销售点的交货区分析

import { GetDeliveryZoneStatsFromPointOfSale } from '@deliverart/sdk-js-stats'

const analytics = await sdk.call(
  new GetDeliveryZoneStatsFromPointOfSale('pos-123', {
    query: {
      'day[after]': '2026-04-01',
      distanceBand: 'between_2km_4km',
      'order[lateRate]': 'desc',
    },
  }),
)

获取一个销售点的快递数据概览

import { GetDeliveryStatsOverviewFromPointOfSale } from '@deliverart/sdk-js-stats'

const overview = await sdk.call(
  new GetDeliveryStatsOverviewFromPointOfSale('pos-123', {
    query: {
      'day[after]': '2026-04-01',
      planningMode: 'PLANNED',
    },
  }),
)

许可证

许可证信息参见SDK主仓库.