pdd.order.basic.list.get订单基础信息列表查询接口(拼多多店铺订单列表查询接口)代码对接教程如下:
1.公共请求参数
参数名称 | 参数类型 | 是否必填 | 参数描述 (代码接口教程wx19970108018) |
---|---|---|---|
type | String | 必填 | API接口名称(点击获取请求key和secret) |
client_id | String | 必填 | POP分配给应用的client_id |
access_token | String | 非必填 | 通过code获取的access_token |
timestamp | String | 必填 | UNIX时间戳,单位秒,需要与拼多多服务器时间差值在10分钟内 |
data_type | String | 非必填 | 响应格式,即返回数据的格式,JSON或者XML(二选一),默认JSON,注意是大写 |
version | String | 非必填 | API协议版本号,默认为V1,可不填 |
sign | String | 必填 | API输入参数签名结果,签名算法参考开放平台接入指南第三部分底部。 |
2.请求参数说明
参数接口 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
end_confirm_at | INTEGER | 必填 | 必填,成交时间结束时间的时间戳,指格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒(北京时间 1970 年 01 月 01 日 08 时 00 分 00 秒)起至现在的总秒数 PS:开始时间结束时间间距不超过 24 小时 |
order_status | INTEGER | 必填 | 发货状态,1:待发货,2:已发货待签收,3:已签收 5:全部 |
page | INTEGER | 必填 | 返回页码 默认 1,页码从 1 开始 PS:当前采用分页返回,数量和页数会一起传,如果不传,则采用 默认值 |
page_size | INTEGER | 必填 | 返回数量,默认 100。最大 100 |
refund_status | INTEGER | 必填 | 售后状态 1:无售后或售后关闭,2:售后处理中,3:退款中,4: 退款成功 5:全部 |
start_confirm_at | INTEGER | 必填 | 必填,成交时间开始时间的时间戳,指格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒(北京时间 1970 年 01 月 01 日 08 时 00 分 00 秒)起至现在的总秒数 |
trade_type | INTEGER | 非必填 | 订单类型 0-普通订单 ,1- 定金订单 |
use_has_next | BOOLEAN | 非必填 | 是否启用has_next的分页方式,如果指定true,则返回的结果中不包含总记录数,但是会新增一个是否存在下一页的的字段,通过此种方式获取增量交易,效率在原有的基础上有80%的提升。 |
3.返回参数
参数接口 参数类型 例子 说明
order_basic_list_get_response OBJECT 1 请求response
has_next BOOLEAN 是否存在下一页
order_list OBJECT[] 1 订单信息列表
cat_id_1 LONG 1 商品一级分类
cat_id_2 LONG 1 商品二级分类
cat_id_3 LONG 1 商品三级分类
cat_id_4 LONG 1 商品四级分类
confirm_time STRING 1 成交时间
delivery_home_value DOUBLE 1 送货入户费用 单位:元
delivery_install_value DOUBLE 1 送货入户并安装费用 单位:元
discount_amount DOUBLE 1 折扣金额,单位:元,折扣金额=平台优惠+商家优惠+团长免单优惠金额
goods_amount DOUBLE 1 商品金额,单位:元,商品金额=商品销售价格*商品数量-改价金额(接口暂无该字段)
home_delivery_type INTEGER 1 送货入户并安装服务 0-不支持送货,1-送货入户不安装,2-送货入户并安装
home_install_value DOUBLE 1 上门安装费用 单位:元
is_lucky_flag INTEGER 1 是否是抽奖订单,1-非抽奖订单,2-抽奖订单
item_list OBJECT[] 1 订单商品列表
goods_count INTEGER 1 商品数量
goods_id STRING 1 商品编码
goods_img STRING 1 商品图片
goods_name STRING 1 商品名称
goods_price DOUBLE 1 商品单件 单价:元
goods_spec STRING 1 商品规格
outer_goods_id STRING 1 商品维度外部编码,注意:编辑商品后必须等待商品审核通过后方可生效,订单中商品信息为交易快照的商品信息。
outer_id STRING 1 sku维度商家外部编码,注意:编辑商品后必须等待商品审核通过后方可生效,订单中商品信息为交易快照的商品信息。
sku_id STRING 1 商品sku编码
order_sn STRING 1 订单编号
order_status INTEGER 1 订单状态
pay_amount DOUBLE 1 支付金额,单位:元,支付金额=商品金额-折扣金额+邮费
platform_discount DOUBLE 1 平台优惠金额,单位:元
postage DOUBLE 1 邮费,单位:元
refund_status INTEGER 1 售后状态
risk_control_status INTEGER 订单审核状态(0-正常订单, 1-审核中订单)
seller_discount DOUBLE 1 商家优惠金额,单位:元
step_order_info OBJECT 1 { "step_discount_amount":4, "advanced_paid_fee":1, "step_paid_fee":1.1, "step_trade_status":2 }
advanced_paid_fee DOUBLE 1 已付定金 单位:元
step_discount_amount DOUBLE 1 膨胀金额 单位:元
step_paid_fee DOUBLE 1 分阶段已付金额 单位:元
step_trade_status INTEGER 1 定金订单状态:step_trade_status 枚举:0-定金未付尾款未付、1-定金已付尾款未付、2-定金已付尾款已付
trade_type INTEGER 1 订单类型 0-普通订单 ,1- 定金订单
updated_at STRING 1 订单的更新时间
total_count INTEGER 1 订单总数
4.请求示例(CURL、PHP 、PHPsdk 、Java 、C# 、Python…)
package com.pdd.pop.sdk.http.demo;
import com.pdd.pop.sdk.common.util.JsonUtil;
import com.pdd.pop.sdk.http.api.pop.request.PddOrderBasicListGetRequest;
import com.pdd.pop.sdk.http.api.pop.response.PddOrderBasicListGetResponse;
import com.pdd.pop.sdk.http.PopClient;
import com.pdd.pop.sdk.http.PopHttpClient;
public class PopClientDemo {
public static void main(String[] args) throws Exception {
String clientId = "your clientId";
String clientSecret = "your clientSecret";
String accessToken = "your accessToken";
PopClient client = new PopHttpClient(clientId, clientSecret);
PddOrderBasicListGetRequest request = new PddOrderBasicListGetRequest();
request.setEndConfirmAt(1);
request.setOrderStatus(1);
request.setPage(1);
request.setPageSize(1);
request.setRefundStatus(1);
request.setStartConfirmAt(1);
request.setTradeType(1);
request.setUseHasNext(false);
PddOrderBasicListGetResponse response = client.syncInvoke(request, accessToken);
System.out.println(JsonUtil.transferToJson(response));
}
}
5.响应示例
{
"order_basic_list_get_response": {
"has_next": false,
"order_list": [
{
"cat_id_1": 1,
"cat_id_2": 1,
"cat_id_3": 1,
"cat_id_4": 1,
"confirm_time": "1",
"delivery_home_value": 1.0,
"delivery_install_value": 1.0,
"discount_amount": 1.0,
"goods_amount": 1.0,
"home_delivery_type": 1,
"home_install_value": 1.0,
"is_lucky_flag": 1,
"item_list": [
{
"goods_count": 1,
"goods_id": "1",
"goods_img": "1",
"goods_name": "1",
"goods_price": 1.0,
"goods_spec": "1",
"outer_goods_id": "1",
"outer_id": "1",
"sku_id": "1"
}
],
"order_sn": "1",
"order_status": 1,
"pay_amount": 1.0,
"platform_discount": 1.0,
"postage": 1.0,
"refund_status": 1,
"risk_control_status": 0,
"seller_discount": 1.0,
"step_order_info": {
"advanced_paid_fee": 1.0,
"step_discount_amount": 1.0,
"step_paid_fee": 1.0,
"step_trade_status": 1
},
"trade_type": 1,
"updated_at": "1"
}
],
"total_count": 1
}
}