基本信息
-
SERVICE_NAME:linkbest.open-service.orders.query.get
-
请求方式:POST
请求Header
Header参数 | 是否必须 | 示例 | 备注 |
---|---|---|---|
Content-Type | 是 | application/json |
公共参数
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
AppKey | 是 | 2312521 | App Key |
Timestamp | 是 | 1596592757 | 秒级时间戳 |
Service | 是 | linkbest.open-Service.orders.query.get | 接口服务名称 |
Sign | 是 | 5D17CCCD5B29F98171D6D0D43136B366 | 签名 |
接口参数
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
WebsiteId | 否 | 媒体id | |
ProgramId | 否 | 计划id | |
SubId | 否 | 子渠道标识 | |
Stime | 是 | 开始时间,秒时间戳,注:时间跨度不能超过1天 | |
Etime | 是 | 结束时间,秒时间戳,注:时间跨度不能超过1天 | |
OrderField | 否 | 时间维度 UpdateTime:更新时间 ChargeTime:结算时间 OrderDatatime:创建时间 默认UpdateTime | |
Status | 否 | 查询在联盟结算状态的订单 可选值: -1 无效 0 待处理 1 已确认 2 已结算 | |
Page | 否 | 页码 默认1 | |
PageSize | 否 | 分页大小 默认20 最大200 |
请求示例
{
"WebsiteId": "string",
"ProgramId": "string",
"SubId": "string",
"Stime": "string",
"Etime": "string",
"OrderField": "string",
"Status": "string",
"Page": "string",
"PageSize": "string"
}
返回参数
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
Status | integer | 非必须 | 状态Code | ||
Message | string | 非必须 | 错误信息 | ||
Data | object | 非必须 | 订单返回 | ||
├─ Id | string | 非必须 | 订单id | ||
├─ ProgramId | string | 非必须 | 计划id | ||
├─ ProgramName | string | 非必须 | 计划名称 | ||
├─ WebsiteId | string | 非必须 | 推广位id | ||
├─ LinkId | string | 非必须 | 推广计划链接ID | ||
├─ SubId | string | 非必须 | 子渠道标识 | ||
├─ OrderSn | string | 非必须 | 订单编号 | ||
├─ ParentOrderSn | string | 非必须 | 父订单号 | ||
├─ OrderTime | string | 非必须 | 订单下单时间,格式:yyyy-MM-dd HH:mm:ss | ||
├─ OrdersPrice | decimal(10,2) | 非必须 | 预估订单金额,例:1.00 | ||
├─ SiterCommission | decimal(10,2) | 非必须 | 预估订单佣金,例:1.00 | ||
├─ Currency | string | 非必须 | 预估订单币种: CNY 人民币 USD 美元 | ||
├─ Status | string | 非必须 | 联盟结算状态:-1 无效 0 未确认 1 确认 2 结算, | ||
├─ ConfirmPrice | decimal(10,2) | 非必须 | 确认订单金额,1.00 | ||
├─ ConfirmSiterCommission | decimal(10,2) | 非必须 | 确认订单佣金,例:1.00 | ||
├─ ChargeCurrency | string | 非必须 | 确认订单币种: CNY 人民币 USD 美元 | ||
├─ ChargeTime | string | 非必须 | 结算时间,格式:yyyy-MM-dd HH:mm:ss | ||
├─ Details | object [] | 非必须 | 订单详情 | item 类型: object | |
├─ ItemCate | string | 非必须 | 商品类目,以实际商家平台结果为准 | ||
├─ ItemCateName | string | 非必须 | 商品类目名称,有可能是数字标识、文字说明,以实际商家平台结果为准 | ||
├─ ItemId | string | 非必须 | 商品编号 | ||
├─ ItemName | string | 非必须 | 商品名称 | ||
├─ ItemPrice | string | 非必须 | 商品单价, 单位:元。币种:固定 CNY人民币 | ||
├─ ItemCount | string | 非必须 | 商品件数 | ||
├─ OrdersPrice | decimal(10,2) | 非必须 | 预估商品金额,币种:和currency字段一致 例:1.00 | ||
├─ OrderStatus | string | 非必须 | 商家平台原始订单状态描述,有可能是英文、中文、数值等,以实际结果为准。 与联盟结算状态无对应关系 | ||
├─ OrderCommission | decimal(10,2) | 非必须 | 预估商品佣金, 币种:和currency字段一致 例:1.00 | ||
├─ OrderSn | string | 非必须 | 订单号 | ||
├─ ParentOrderSn | string | 非必须 | 父订单号/子订单号 | ||
├─ ItemImg | string | 非必须 | 商品图片地址 | ||
├─ ShopTitle | string | 必须 | 店铺名称 | ||
├─ LbOrderStatus | string | 非必须 | :-1未知,1待付款,2已付款,21处理中,3已发货,31配送中,32已拒签,4已收货,41结算中,5已结算,6失效,7已完成,8维权中,81维权成功,82维权失败,9退款,10退货,11系统锁定; |
返回示例
{
"Status": 0,
"Message": "string",
"Data": [{
"Id": "string",
"ProgramId": "string",
"ProgramName": "string",
"WebsiteId": "string",
"LinkId": "string",
"SubId": "string",
"OrderSn": "string",
"ParentOrderSn": "string",
"OrderTime": "string",
"OrdersPrice": null,
"SiterCommission": null,
"Currency": "string",
"Status": "string",
"ConfirmPrice": null,
"ConfirmSiterCommission": null,
"ChargeCurrency": "string",
"ChargeTime": "string",
"Pagination":{
"Page":1,
"PageSize":20,
"Total":0
},
"Details": [
{
"ItemCate": "string",
"ItemCateName": "string",
"ItemId": "string",
"ItemName": "string",
"ItemPrice": "string",
"ItemCount": "string",
"OrdersPrice": null,
"OrderStatus": "string",
"OrderCommission": null,
"OrderSn": "string",
"ParentOrderSn": "string",
"ItemImg": "string",
"ShopTitle": "string",
"LbOrderStatus": "string"
}
]
}]
}