帮助中心 >
索样请求
Object: sample-request
Primary Locator:
- requestId
1. Schema
sampleRequestBasicInfo
| Field | 中文属性 | Type | 中文说明 | English Description |
|---|---|---|---|---|
| requestId | 索样ID | string | 索样请求唯一业务ID | Unique business ID of the sample request |
| orderId | 索样订单ID | string | 索样对应的订单ID | Order ID generated from the sample request |
| creatorId | 达人ID | string | 发起索样请求的达人ID | Creator ID of the sample request |
| creatorNickname | 达人昵称 | string | 发起索样请求的达人昵称 | Creator nickname of the sample request |
| productId | 商品ID | string | 被申请索样的商品ID | Product ID requested for sampling |
| productName | 索样商品 | string | 被申请索样的商品名称 | Product name requested for sampling |
| sku | SKU | string | 被申请索样的 SKU 信息 | SKU requested for sampling |
| commissionRate | 佣金比例 | number | 达人申请时对应的佣金比例 | Commission rate of the sample request |
| status | 状态 | string | 当前索样请求状态，如：待审批、待发货、已发货、已完成、已取消 | Current status of the sample request |
| archived | 是否搁置 | boolean | 当前索样请求是否被搁置 | Whether the sample request is archived |
| requestTime | 申请时间 | datetime | 达人发起索样申请时间 | Time when the creator submitted the sample request |
| owners | 跟进人 | string[] | 负责该索样请求的 BD 人员列表 | BD owners responsible for the sample request |
| expireTime | 过期时间 | datetime | 索样申请过期时间 | Expiration time of the sample request |
| otherShopSampleRequests | 其他店铺索样记录 | number | 达人在其它店铺的历史索样次数 | Historical sample request count from other shops |
| otherShopSameProductRequests | 其他店铺相同商品索样记录 | number | 达人在其它店铺对相同商品的历史索样次数 | Historical sample request count for the same product from other shops |
| currentShopSampleRequests | 本店铺索样记录 | number | 达人在当前店铺的历史索样次数 | Historical sample request count from the current shop |
| videoMediaIds | 视频作品 | string[] | 达人因该索样请求产出的视频 mediaId 列表 | Video mediaIds generated from the sample request |
| liveMediaIds | 直播作品 | string[] | 达人因该索样请求产出的直播 mediaId 列表 | LIVE mediaIds generated from the sample request |
| updateTime | 更新时间 | datetime | 索样请求最近更新时间 | Last updated time of the sample request |
2. Action Specs
Returns: sampleRequest[]
huayangtk-cli sample-request
huayangtk-cli sample-request --creator-id <string>
huayangtk-cli sample-request --product-id <string>
huayangtk-cli sample-request --sku <string>
huayangtk-cli sample-request --status <string>
huayangtk-cli sample-request --archived <boolean>
huayangtk-cli sample-request --start-time <datetime> --end-time <datetime>
huayangtk-cli sample-request --creator-id <string> --status <string>
huayangtk-cli sample-request --product-id <string> --status <string>
huayangtk-cli sample-request --status <string> --archived <boolean>
huayangtk-cli sample-request list
huayangtk-cli sample-request list --creator-id <string>
huayangtk-cli sample-request list --product-id <string>
huayangtk-cli sample-request list --sku <string>
huayangtk-cli sample-request list --status <string>
huayangtk-cli sample-request list --archived <boolean>
huayangtk-cli sample-request list --start-time <datetime> --end-time <datetime>
huayangtk-cli sample-request list --creator-id <string> --status <string>
huayangtk-cli sample-request list --product-id <string> --status <string>
huayangtk-cli sample-request list --status <string> --archived <boolean>
Returns: sampleRequest[]
huayangtk-cli sample-request pending
huayangtk-cli sample-request pending --creator-id <string>
huayangtk-cli sample-request pending --product-id <string>
huayangtk-cli sample-request pending --start-time <datetime> --end-time <datetime>
Returns: sampleRequest
huayangtk-cli sample-request get --request-id <string>
Returns: video[]
huayangtk-cli sample-request videos --request-id <string>
Returns: live[]
huayangtk-cli sample-request lives --request-id <string>
Returns: sampleRequest
huayangtk-cli sample-request set-status --request-id <string> --status <string>
Returns: sampleRequest
huayangtk-cli sample-request archive --request-id <string>
huayangtk-cli sample-request unarchive --request-id <string>
