媒体伙伴接入
API 文档
订单列表

基本信息

  • SERVICE_NAME:linkbest.open-service.orders.query.get

  • 请求方式:POST

请求Header

Header参数是否必须示例备注
Content-Typeapplication/json

公共参数

参数名称是否必须示例备注
AppKey2312521App Key
Timestamp1596592757秒级时间戳
Servicelinkbest.open-Service.orders.query.get接口服务名称
Sign5D17CCCD5B29F98171D6D0D43136B366签名

接口参数

参数名称是否必须示例备注
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"
}

返回参数

名称类型是否必须默认值备注其他信息
Statusinteger非必须状态Code
Messagestring非必须错误信息
Dataobject非必须订单返回
├─ Idstring非必须订单id
├─ ProgramIdstring非必须计划id
├─ ProgramNamestring非必须计划名称
├─ WebsiteIdstring非必须推广位id
├─ LinkIdstring非必须推广计划链接ID
├─ SubIdstring非必须子渠道标识
├─ OrderSnstring非必须订单编号
├─ ParentOrderSnstring非必须父订单号
├─ OrderTimestring非必须订单下单时间,格式:yyyy-MM-dd HH:mm:ss
├─ OrdersPricedecimal(10,2)非必须预估订单金额,例:1.00
├─ SiterCommissiondecimal(10,2)非必须预估订单佣金,例:1.00
├─ Currencystring非必须预估订单币种: CNY 人民币 USD 美元
├─ Statusstring非必须联盟结算状态:-1 无效 0 未确认 1 确认 2 结算,
├─ ConfirmPricedecimal(10,2)非必须确认订单金额,1.00
├─ ConfirmSiterCommissiondecimal(10,2)非必须确认订单佣金,例:1.00
├─ ChargeCurrencystring非必须确认订单币种: CNY 人民币 USD 美元
├─ ChargeTimestring非必须结算时间,格式:yyyy-MM-dd HH:mm:ss
├─ Detailsobject []非必须订单详情

item 类型: object

├─ ItemCatestring非必须商品类目,以实际商家平台结果为准
├─ ItemCateNamestring非必须商品类目名称,有可能是数字标识、文字说明,以实际商家平台结果为准
├─ ItemIdstring非必须商品编号
├─ ItemNamestring非必须商品名称
├─ ItemPricestring非必须商品单价, 单位:元。币种:固定 CNY人民币
├─ ItemCountstring非必须商品件数
├─ OrdersPricedecimal(10,2)非必须预估商品金额,币种:和currency字段一致 例:1.00
├─ OrderStatusstring非必须商家平台原始订单状态描述,有可能是英文、中文、数值等,以实际结果为准。 与联盟结算状态无对应关系
├─ OrderCommissiondecimal(10,2)非必须预估商品佣金, 币种:和currency字段一致 例:1.00
├─ OrderSnstring非必须订单号
├─ ParentOrderSnstring非必须父订单号/子订单号
├─ ItemImgstring非必须商品图片地址
├─ ShopTitlestring必须店铺名称
├─ LbOrderStatusstring非必须:-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"
            }
        ]
    }]
}