GET代码目录
/tool/open_api/api/user/order
请求Params
请求 Header
响应定义
请求参数
Query参数
Header参数
数据结构
export interface Response {
code: number;
data: Data;
msg: string;
}
export interface Data {
/**
* 总计数量
*/
count: number;
/**
* 订单列表
*/
list: List[];
/**
* 当前页
*/
page: number;
/**
* 分页总数
*/
pageCount: number;
/**
* 每页数量
*/
pageSize: number;
}
/**
* 订单信息
*/
export interface List {
/**
* 跨店优惠券优惠金额
*/
acrossStoreCouponPrice: string;
/**
* 联系地址，快递发货
*/
address: string;
/**
* 自动取消时间
*/
autoCancelTime: string;
/**
* 订单自动关闭时间
*/
autoCloseTime: string;
/**
* 自动确认收货时间
*/
autoConfirmTime: string;
/**
* 自动完成时间
*/
autoSalesTime: string;
/**
* 后台优惠，正数表示优惠，负数表示加价
*/
backPrice: string;
/**
* 订单申请退款数据
*/
cancelData: string[];
/**
* 取消状态
*/
cancelStatus: number;
/**
* 取消时间
*/
cancelTime: string;
/**
* 同城配送信息
*/
cityInfo: null;
/**
* 联系方式，同城配送
*/
cityMobile: string;
/**
* 联系人，同城配送
*/
cityName: null;
clerk?: Clerk;
/**
* 核销员id，订单核销之后才会生成
*/
clerkid: string;
/**
* 评价时间
*/
commentTime: string;
/**
* 收货时间
*/
confirmTime: string;
/**
* 优惠券优惠金额
*/
couponDiscountPrice: string;
/**
* 创建订单的用户id，订单创建用户，0--表示订单由归属用户创建
*/
createUserid: string;
/**
* 订单创建时间
*/
createdAt: string;
/**
* 京东商家编号，京东发货时需要
*/
customerName: string;
/**
* 订单删除时间
*/
deletedAt: string;
/**
* 订单详情列表
*/
detail: Detail[];
/**
* 订单发货情况
*/
detailExpress?: DetailExpress[];
/**
* 同城配送距离，-1不在范围内，正数为距离KM
*/
distance: string;
/**
* 运费原价
*/
expressOriginalPrice: string;
/**
* 运费实付价格
*/
expressPrice: string;
/**
* 满减优惠金额
*/
fullReducePrice: string;
/**
* 订单类型，主要用于自定义交易组件
*/
fundType: number;
/**
* 商品总数量
*/
goodsNum: number;
/**
* 订单id
*/
id: string;
/**
* 积分优惠金额
*/
integralDeductionPrice: string;
/**
* 是否评价
*/
isComment: number;
/**
* 是否确认收货
*/
isConfirm: number;
/**
* 是否删除
*/
isDelete: number;
/**
* 是否支付
*/
isPay: number;
/**
* 是否加入回收站
*/
isRecycle: number;
/**
* 是否完成
*/
isSale: number;
/**
* 是否发货
*/
isSend: number;
/**
* 联系地址，同城配送
*/
location: null;
/**
* 商城id
*/
mallid: string;
/**
* 多商户信息
*/
mch: null | FluffyMch;
/**
* 多商户id
*/
mchid: string;
/**
* 会员优惠金额
*/
memberDiscountPrice: string;
/**
* 联系方式，快递发货和到店自提
*/
mobile: string;
/**
* 联系人，快递发货和到店自提
*/
name: string;
/**
* 状态字段（转成二进制查看），从右往左查看依次：是否中断交易、是否关闭
*/
newStatus: NewStatus;
/**
* 用户昵称
*/
nickname: string;
/**
* 订单剩余未发货的商品数量
*/
notSendCount: number;
/**
* 下单表单，和下单备注二选一
*/
orderForm: string[];
/**
* 订单号
*/
orderNo: string;
/**
* 订单状态
*/
orderStatus: number;
/**
* 订单核销信息
*/
orderClerk?: OrderClerk;
/**
* 支付时间
*/
payTime: string;
/**
* 支付方式
*/
payType: number;
/**
* 订单所属平台
*/
platform: Platform;
/**
* 平台标示
*/
platformIcon: string;
/**
* 插件信息
*/
pluginData: PluginData;
/**
* 插件名称
*/
pluginName: string;
/**
* 下单备注，和下单表单二选一
*/
remark: string;
/**
* 是否申请售后
*/
saleStatus: number;
/**
* 场景值，暂时只有微信小程序有
*/
scene: string;
/**
* 门店核销方式
*/
selectStoreType: SelectStoreType;
/**
* 商家备注
*/
sellerRemark: string;
/**
* 发货时间
*/
sendTime: string;
/**
* 发货方式
*/
sendType: SendType;
/**
* 订单所属插件，值为各个插件的标示，空表示商城订单
*/
sign: string;
/**
* 核销门店信息，到店自提
*/
store?: null | StoreStore;
/**
* 自提门店ID，单门店核销时
*/
storeid: number;
/**
* 可自提门店id列表，多门店核销时
*/
storeidList: null | string;
/**
* 支持的支付方式，空表示支持系统设置支持的所有方式
*/
supportPayTypes: string;
/**
* 商品原价，优惠前
*/
totalGoodsOriginalPrice: string;
/**
* 商品实付金额，优惠后
*/
totalGoodsPrice: string;
/**
* 订单实付金额，优惠后
*/
totalPayPrice: string;
/**
* 订单总价，优惠前
*/
totalPrice: string;
/**
* 跟踪ID，有效期十分钟，会影响主播归因、分享员归因等，需创建订单前调用，调用生成订单api时需传入该参数；暂时只有微信小程序有
*/
traceid: string;
/**
* 订单修改时间
*/
updatedAt: string;
/**
* 跨店优惠券ID
*/
useAcrossStoreCouponid: string;
/**
* 使用积分数
*/
useIntegralNum: string;
/**
* 使用优惠券id
*/
useUserCouponid: string;
/**
* 下单用户id，订单归属用户
*/
userid: string;
/**
* 商家留言
*/
words: string;
}
export interface Clerk {
/**
* 核销员昵称
*/
nickname: string;
}
/**
* 订单详情
*/
export interface Detail {
/**
* 跨店优惠券优惠金额
*/
acrossStoreCouponPrice: string;
/**
* 规格信息，购买的
*/
attrList: DetailAttrList[];
/**
* 后台优惠，正数表示优惠，负数表示加价
*/
backPrice: string;
/**
* 抹零价格
*/
erasePrice: string;
/**
* 自定义表单提交的数据
*/
formData: string;
/**
* 自定义表单的id
*/
formid: string;
/**
* 商品信息，即时信息
*/
goods: Goods;
/**
* 商品id
*/
goodsid: string;
/**
* 商品快照
*/
goodsInfo: GoodsInfo;
/**
* 商品货号
*/
goodsNo: string;
/**
* 商品类型
*/
goodsType: GoodsType;
/**
* 订单详情id
*/
id: string;
/**
* 是否退款
*/
isRefund: number;
/**
* 会员优惠金额
*/
memberDiscountPrice: string;
/**
* 数量
*/
num: string;
/**
* 订单id
*/
orderid: string;
/**
* 所属插件名称
*/
pluginName: string;
/**
* 售后状态
*/
refundStatus: number;
/**
* 售后情况
*/
refundStatusText: string;
/**
* 插件标示
*/
sign: string;
/**
* 总价，优惠前
*/
totalOriginalPrice: string;
/**
* 实付金额，优惠后
*/
totalPrice: string;
/**
* 单价
*/
unitPrice: string;
}
export interface DetailAttrList {
/**
* 规格组id
*/
attrGroupid: number;
/**
* 规格组名称
*/
attrGroupName: string;
/**
* 规格id
*/
attrid: number;
/**
* 规格名称
*/
attrName: string;
}
/**
* 商品信息，即时信息
*/
export interface Goods {
/**
* 规格信息
*/
attrGroups: string;
/**
* 规格样式
*/
attrStyle: number;
/**
* 商品库存
*/
goodsStock: string;
/**
* 商品基本信息，即时信息
*/
goodsWarehouse: GoodsWarehouse;
/**
* 商品ID
*/
id: string;
mch: null | PurpleMch;
/**
* 售价
*/
price: string;
/**
* 插件标示，空表示商城商品
*/
sign: string;
/**
* 是否使用规格
*/
useAttr: number;
/**
* 虚拟销量
*/
virtualSales: number;
}
/**
* 商品基本信息，即时信息
*/
export interface GoodsWarehouse {
/**
* 成本价
*/
costPrice: string;
/**
* 商品缩略图
*/
coverPic: string;
/**
* 卡密id
*/
ecardid: string;
/**
* 商品库id
*/
id: string;
/**
* 关键词
*/
keyword: string;
/**
* 商品名称
*/
name: string;
/**
* 原价
*/
originalPrice: string;
/**
* 商品轮播图
*/
picurl: string;
/**
* 副标题
*/
subtitle: string;
/**
* 商品类型
*/
type: string;
/**
* 单位
*/
unit: string;
/**
* 商品视频
*/
videourl: string;
}
export interface PurpleMch {
accountMoney: string;
createdAt: string;
deletedAt: string;
formData: string;
id: string;
isDelete: string;
isRecommend: string;
mallid: string;
mchCommonCatid: string;
mobile: string;
realname: string;
reviewRemark: string;
reviewStatus: string;
reviewTime: string;
sort: string;
status: string;
store: MchStore;
transferRate: string;
updatedAt: string;
userid: string;
wechat: string;
}
export interface MchStore {
address: string;
businessHours: string;
cityid: string;
coverurl: string;
createdAt: string;
deletedAt: string;
description: string;
districtid: string;
extraAttributes: string;
id: string;
isAllDay: string;
isDefault: string;
isDelete: string;
latitude: string;
longitude: string;
mallid: string;
mchid: string;
mobile: string;
name: string;
picurl: string;
provinceid: string;
scope: string;
score: string;
status: string;
updatedAt: string;
}
/**
* 商品快照
*/
export interface GoodsInfo {
attrList: GoodsInfoAttrList[];
goodsAttr: GoodsAttr;
}
export interface GoodsInfoAttrList {
attrGroupid: number;
attrGroupName: string;
attrid: number;
attrName: string;
}
export interface GoodsAttr {
attrSettingType: number;
barCode: string;
costPrice: string;
coverPic: string;
discount: string[];
ecardid: number;
extra: string[];
goodsAttrPrice: string;
goodsid: number;
goodsOriginalPrice: string;
goodsShareLevel: GoodsShareLevel[] | null;
goodsType: string;
goodsWarehouseid: number;
id: number;
individualShare: number;
integralPrice: null;
isShare: number;
memberPrice: number | null;
name: string;
no: string;
number: Number;
originalPrice: string;
picList: PicList[];
picurl: string;
price: Number;
shareType: number;
signid: string;
stock: number;
useIntegral: null;
weight: number;
}
export interface GoodsShareLevel {
level: number;
shareCommissionFirst: string;
shareCommissionSecond: string;
shareCommissionThird: string;
}
export type Number = number | string;
export interface PicList {
id: string;
picurl: string;
}
/**
* 商品类型
*/
export type GoodsType = "goods" | "ecard" | "form-goods";
export interface DetailExpress {
/**
* 配送信息
*/
cityInfo: string;
/**
* 联系方式，配送员
*/
cityMobile: string;
/**
* 联系人，配送员
*/
cityName: string;
/**
* 快递公司
*/
express: string;
/**
* 物流内容
*/
expressContent: string;
/**
* 快递单号
*/
expressNo: string;
/**
* 配送类型
*/
expressType: string;
/**
* 商家留言
*/
merchantRemark: string;
/**
* 发货方式
*/
sendType: number;
}
export interface FluffyMch {
/**
* 商户名称
*/
mchName: string;
/**
* 商户联系方式
*/
mobile: string;
/**
* 商户联系人
*/
realname: string;
}
/**
* 状态字段（转成二进制查看），从右往左查看依次：是否中断交易、是否关闭
*/
export type NewStatus = "00" | "11" | "10" | "01";
/**
* 订单核销信息
*/
export interface OrderClerk {
/**
* 确认收款类型，货到付款方式
*/
affirmPayType: number;
/**
* 核销备注
*/
clerkRemark: string;
/**
* 核销类型
*/
clerkType: number;
}
/**
* 订单所属平台
*/
export type Platform = "wxapp" | "aliapp" | "bdapp" | "ttapp" | "wechat" | "mobile";
/**
* 插件信息
*/
export interface PluginData {
/**
* 折扣说明
*/
discountList: DiscountList[];
/**
* 数量
*/
exchangeCount?: string;
/**
* 价格信息
*/
priceList: PriceList[];
/**
* 额外货币名称，例如：积分、活力比等
*/
priceName?: string;
}
export interface DiscountList {
/**
* 名称
*/
label: string;
/**
* 内容
*/
value: string;
}
export interface PriceList {
/**
* 名称
*/
label: string;
/**
* 内容
*/
value: string;
}
/**
* 门店核销方式
*/
export type SelectStoreType = "alone" | "much";
/**
* 发货方式
*/
export type SendType = "offline" | "express" | "city";
export interface StoreStore {
/**
* 联系地址
*/
address: string;
/**
* 门店描述
*/
description: string;
/**
* 门店id
*/
id: string;
/**
* 联系方式
*/
mobile: string;
/**
* 门店名称
*/
name: string;
}
示例代码
{
"msg": "string",
"data": {
"list": [
{
"id": "string",
"mall_id": "string",
"user_id": "string",
"mch_id": "string",
"order_no": "string",
"total_price": "string",
"total_pay_price": "string",
"express_original_price": "string",
"express_price": "string",
"total_goods_price": "string",
"total_goods_original_price": "string",
"member_discount_price": "string",
"full_reduce_price": "string",
"use_user_coupon_id": "string",
"coupon_discount_price": "string",
"use_integral_num": "string",
"integral_deduction_price": "string",
"name": "string",
"mobile": "string",
"address": "string",
"remark": "string",
"order_form": [
"string"
],
"words": "string",
"seller_remark": "string",
"is_pay": 0,
"pay_type": 0,
"pay_time": "string",
"is_send": 0,
"send_time": "string",
"customer_name": "string",
"is_sale": 0,
"is_confirm": 0,
"confirm_time": "string",
"cancel_status": 0,
"cancel_time": "string",
"created_at": "string",
"updated_at": "string",
"deleted_at": "string",
"is_delete": 0,
"is_recycle": 0,
"send_type": "offline",
"clerk_id": "string",
"store_id": 0,
"store_id_list": "string",
"auto_close_time": "string",
"select_store_type": "alone",
"sign": "string",
"support_pay_types": "string",
"is_comment": 0,
"comment_time": "string",
"sale_status": 0,
"back_price": "string",
"auto_cancel_time": "string",
"auto_confirm_time": "string",
"auto_sales_time": "string",
"distance": "string",
"city_mobile": "string",
"location": null,
"city_name": null,
"city_info": null,
"cancel_data": [
"string"
],
"platform": "wxapp",
"new_status": "00",
"fund_type": 0,
"scene": "string",
"trace_id": "string",
"create_user_id": "string",
"use_across_store_coupon_id": "string",
"across_store_coupon_price": "string",
"nickname": "string",
"mch": {
"mch_name": "string",
"mobile": "string",
"realname": "string"
},
"detail": [
{
"id": "string",
"order_id": "string",
"goods_id": "string",
"num": "string",
"unit_price": "string",
"total_original_price": "string",
"total_price": "string",
"member_discount_price": "string",
"erase_price": "string",
"goods_info": {
"attr_list": [
{
"attr_group_name": "string",
"attr_group_id": 0,
"attr_id": 0,
"attr_name": "string"
}
],
"goods_attr": {
"id": 0,
"goods_id": 0,
"sign_id": "string",
"stock": 0,
"price": "string",
"original_price": "string",
"no": "string",
"bar_code": "string",
"weight": 0,
"pic_url": "string",
"is_share": 0,
"individual_share": 0,
"share_type": 0,
"member_price": 0,
"integral_price": null,
"use_integral": null,
"discount": [
"string"
],
"extra": [
"string"
],
"goods_warehouse_id": 0,
"name": "string",
"cover_pic": "string",
"pic_list": [
{
"id": "string",
"pic_url": "string"
}
],
"number": 0,
"goods_share_level": [
{
"share_commission_first": "string",
"share_commission_second": "string",
"share_commission_third": "string",
"level": 0
}
],
"attr_setting_type": 0,
"goods_type": "string",
"ecard_id": 0,
"cost_price": "string",
"goods_original_price": "string",
"goods_attr_price": "string"
}
},
"is_refund": 0,
"refund_status": 0,
"back_price": "string",
"sign": "string",
"goods_no": "string",
"form_data": "string",
"form_id": "string",
"goods_type": "goods",
"across_store_coupon_price": "string",
"goods": {
"id": "string",
"price": "string",
"use_attr": 0,
"attr_groups": "string",
"attr_style": 1,
"goods_stock": "string",
"virtual_sales": 0,
"sign": "string",
"mch": {
"id": "string",
"mall_id": "string",
"user_id": "string",
"status": "string",
"is_recommend": "string",
"review_status": "string",
"review_remark": "string",
"review_time": "string",
"realname": "string",
"wechat": "string",
"mobile": "string",
"mch_common_cat_id": "string",
"transfer_rate": "string",
"account_money": "string",
"sort": "string",
"form_data": "string",
"created_at": "string",
"updated_at": "string",
"deleted_at": "string",
"is_delete": "string",
"store": {
"id": "string",
"mall_id": "string",
"mch_id": "string",
"name": "string",
"mobile": "string",
"address": "string",
"province_id": "string",
"city_id": "string",
"district_id": "string",
"longitude": "string",
"latitude": "string",
"score": "string",
"cover_url": "string",
"pic_url": "string",
"business_hours": "string",
"description": "string",
"scope": "string",
"is_default": "string",
"created_at": "string",
"updated_at": "string",
"deleted_at": "string",
"is_delete": "string",
"is_all_day": "string",
"extra_attributes": "string",
"status": "string"
}
},
"goodsWarehouse": {
"id": "string",
"name": "string",
"subtitle": "string",
"keyword": "string",
"original_price": "string",
"cost_price": "string",
"cover_pic": "string",
"pic_url": "string",
"video_url": "string",
"unit": "string",
"type": "string",
"ecard_id": "string"
}
},
"attr_list": [
{
"attr_group_name": "string",
"attr_group_id": 0,
"attr_id": 0,
"attr_name": "string"
}
],
"plugin_name": "string",
"refund_status_text": "string"
}
],
"clerk": {
"nickname": "string"
},
"store": {
"id": "string",
"name": "string",
"mobile": "string",
"address": "string",
"description": "string"
},
"orderClerk": {
"affirm_pay_type": 1,
"clerk_type": 1,
"clerk_remark": "string"
},
"detailExpress": [
{
"express": "string",
"express_no": "string",
"send_type": 0,
"merchant_remark": "string",
"express_content": "string",
"city_mobile": "string",
"city_info": "string",
"city_name": "string",
"express_type": "string"
}
],
"platform_icon": "string",
"plugin_name": "string",
"goods_num": 0,
"not_send_count": 0,
"order_status": 0,
"plugin_data": {
"price_list": [
{
"label": "string",
"value": "string"
}
],
"discount_list": [
{
"label": "string",
"value": "string"
}
],
"price_name": "string",
"exchange_count": "string"
}
}
],
"page": 0,
"pageCount": 0,
"pageSize": 0,
"count": 0
},
"code": 0
}
