帮助中心 >
订单
Object: order
Primary Locator:
- orderId
1. Schema
orderBasicInfo
| Field | 中文属性 | Type | 中文说明 | English Description |
|---|---|---|---|---|
| orderId | 订单ID | string | 订单唯一业务ID | Unique business ID of the order |
| buyerId | 买家ID | string | 下单买家ID | Buyer ID of the order |
| shopName | 店铺 | string | 订单所属店铺名称 | Shop name of the order |
| shopCode | 店铺编码 | string | 订单所属店铺编码 | Shop code of the order |
| orderType | 订单类型 | string | 订单类型，如：真实订单 | Type of the order |
| quantity | 购买数量 | number | 订单商品购买数量 | Quantity purchased in the order |
| paidAmount | 实付金额 | number | 买家实际支付金额 | Actual paid amount of the order |
| creatorId | 带货达人 | string | 带来该订单的达人ID | Creator ID responsible for the order |
| creatorNickname | 达人昵称 | string | 带来该订单的达人昵称 | Creator nickname responsible for the order |
| mediaId | 媒体ID | string | 带来该订单的视频或直播 mediaId | Media ID of the video or LIVE session that generated the order |
| trafficSource | 带货来源 | string | 订单来源渠道，如：视频、直播 | Traffic source of the order |
| totalCommission | 总佣金 | number | 订单总佣金金额 | Total commission amount of the order |
| status | 状态 | string | 当前订单状态，如：待发货、已完成、已取消 | Current order status |
| purchaseTime | 购买时间 | datetime | 买家下单时间 | Purchase time of the order |
| note | 备注 | string | 用户自定义备注信息 | User-defined note for the order |
| updateTime | 更新时间 | datetime | 订单最近更新时间 | Last updated time of the order |
| items | 订单商品 | orderItem[] | 当前订单中的商品列表 | Product items in the order |
orderItem
| Field | 中文属性 | Type | 中文说明 | English Description |
|---|---|---|---|---|
| productId | 商品ID | string | 订单商品ID | Product ID in the order |
| productName | 商品名称 | string | 订单商品名称 | Product name in the order |
| quantity | 商品数量 | number | 当前商品购买数量 | Purchased quantity of the product |
| paidAmount | 商品实付金额 | number | 当前商品实际支付金额 | Actual paid amount of the product |
| adCommission | 广告佣金 | number | 当前商品广告佣金金额 | Advertising commission amount of the product |
| commissionRate | 佣金比例 | number | 当前商品佣金比例 | Commission rate of the product |
| commission | 佣金 | number | 当前商品佣金金额 | Commission amount of the product |
2. Action Specs
Returns: order[]
huayangtk-cli order
huayangtk-cli order --shop-code <string>
huayangtk-cli order --creator-id <string>
huayangtk-cli order --status <string>
huayangtk-cli order --traffic-source <string>
huayangtk-cli order --media-id <string>
huayangtk-cli order --start-time <datetime> --end-time <datetime>
huayangtk-cli order --shop-code <string> --status <string>
huayangtk-cli order --creator-id <string> --status <string>
huayangtk-cli order --media-id <string> --status <string>
huayangtk-cli order list
huayangtk-cli order list --shop-code <string>
huayangtk-cli order list --creator-id <string>
huayangtk-cli order list --status <string>
huayangtk-cli order list --traffic-source <string>
huayangtk-cli order list --media-id <string>
huayangtk-cli order list --start-time <datetime> --end-time <datetime>
huayangtk-cli order list --shop-code <string> --status <string>
huayangtk-cli order list --creator-id <string> --status <string>
huayangtk-cli order list --media-id <string> --status <string>
Returns: order
huayangtk-cli order get --order-id <string>
Returns: order
huayangtk-cli order note --order-id <string> --note <string>
