开发指南
API
官网
API 2.0
API 2.0 > 5.1 订单查询 > 5.1.1 订单列表

5.1.1 订单列表

开启令牌和权限后可调用。签名方式请查看开发指南
场景描述：获取当前店铺下所有的订单列表
零售

请求地址

请求方式 版本信息 请求地址
POST V2 http://openapi.zvcms.com/api/v2

公共参数

参数 参数类型 是否必填 默认值 描述
OpenId string 是 密钥Id
GrantCode string 是 授权code
Token string 是 签名，参考《数字签名sign》
Timestamp string 是 当前时间戳
Nonce string 是 随机正整数
Action string 是 order.list-all 接口方法
Params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
type string 否 订单类型： 1 商品订单, 2 扫码订单， 3 储值订单， 4 用户付款码订单， 5 拼团订单，6 礼品卡订单， 7 微众订单， 8 卡券订单， 9 扫码购订单， 10 会员卡订单， 11 F码订单， 12 积分兑换订单；
code int 否 自提提货码
pay_mode int 否 付款方式：0 全部， 1 微信支付，2 支付宝支付， 3 余额支付， 4 现金支付， 5 自有微信， 6 自有支付宝，7 pos刷卡支付， 8 微众支付，9 混合支付；
limit int 否 每页大小
page int 否 当前页码
send_status int 否 发货状态：0 未发货，1 已发货，2 部分发货；
status int 否 订单状态：0 全部， 1 待支付，2 退款中， 3待发货，4 待收货，5已取消，6，已作废，7 已完成， 8 已关闭，9 已删除， 10 待接单， 11 待自提；
source int 否 订单来源：2 独立零售，3 线下门店，4 第三方订单， 5 收银机订单；
dispatch int 否 配送方式：0 扫码买单，1 快递发货， 2 同城配送，3 预约自提；
multi_store_sn string 否 多门店编码
begin_time TimeStamp 否 下单时间（开始）
end_time TimeStamp 否 下单时间（结束）
pay_begin_time TimeStamp 否 付款时间（开始）
pay_end_time TimeStamp 否 付款时间（结束）
send_begin_time TimeStamp 否 发货时间（开始）
send_end_time TimeStamp 否 发货时间（结束）
order_no string 否 String 订单编号
user_id int 否 用户ID
keywords String 否 商品名称
mobile Mobile 否 配送手机号
pick_mobile Mobile 否 买家手机号
pick_begin_time TimeStamp 否 自提订单、同城配送预约发货 开始时间
pick_end_time TimeStamp 否 自提订单、同城配送预约发货 结束时间
group_status int 否 0 描述：拼团成团状态筛选 1:全部 2:拼团中 3:拼团失败 4:拼团成功

响应参数

参数 参数类型 描述
status bool 成功或失败
code int 成功/错误编码
message string 成功/错误描述
data array
 ├orders array
  ├current_page int 当前页
  ├data array
   ├0 array
    ├id int 订单ID号
    ├store_id int 商家ID
    ├order_no int 订单编号
    ├user_id int 用户ID
    ├order_type int 订单类型1- 商品订单,2- 扫码订单,3- 购买储值订单,4- 扫用户付款码订单,5- 拼团订单,6- 礼品卡订单,7- 微众订单,8- 卡券订单,9- 扫码购订单,10- 会员卡订单
    ├status int 订单状态 1生成订单,2支付订单,3取消订单(客户触发),4作废订单(管理员触发),5完成订单,6已关闭
    ├total_amount int 订单总金额
    ├amount int 应付金额
    ├refund_status int 是否申请退款
    ├invoice int 是否开发票
    ├invoice_type int 发票类型 1-单位 0-个人
    ├invoice_title String 发票title
    ├invoice_tax_code String 增值税税号
    ├refund int 退款数量
    ├comment_status int 评论状态
    ├completed_at int 订单完成时间
    ├comment_at int 评价时间
    ├user_remarks int 用户备注
    ├seller_remarks int 商家备注
    ├created_at Int 下单时间
    ├updated_at int 更新时间
    ├ext string 扩展信息表
    ├source Int 订单来源 1：平台 2：商户
    ├send_status Int 发货状态：0 未发货，1 已发货，2 部分发货；
    ├pay_at string 外部支付订单编号
    ├inside_trade_no string 内部支付订单编号
    ├payment_id int 支付方式ID 0- 无第三方支付方式,1- 微信支付,2- 支付宝支付,4- 现金支付,5- 自有微信,6- 自有支付宝,7- pos刷卡支付,9- 微众卡支付
    ├not_use_discount_amount int 订单新增不参与优惠的金额
    ├dispatch_type int 配送类型 0 扫码买单 1：快递 2：同城 3：自提
    ├pick_user string 提货人姓名
    ├pick_mobile string 提货人联系电话
    ├self_pick_id int 自提点编号
    ├addr_id int 收货人地址编号
    ├freight int 运费
    ├minus_amount int 优惠总金额
    ├card_minus int 会员折扣
    ├coupon_discount int 会员折扣
    ├pick_at int 提货时间
    ├multi_store_id int 多门店ID，默认0-不关联到门店
    ├use_wallet int 是否使用钱包支付 0- 未使用 1-使用
    ├wallet_amount int 钱包使用金额
    ├is_invoice int 是否开发票1:不开发票 2：开
    ├index_stock int 是否使用独立库存 0- 未使用 1- 使用
    ├reserve_delivery_time Date 预约配送时段
    ├use_wallet_source Int 子配送快递方式 0-自送
    ├receive_status Int 订单接收状态 0-未接单 1-已接单
    ├receive_at Int 接单时间
    ├is_auto_verify int 核销类型 0- 默认 1- 商家核销 2- 系统自动核销
    ├pick_up_time string 自提预约时间
    ├third_trade_no string 第三方支付订单编号
    ├receive_point int 订单获得积分
    ├cashback_order_no string 返现订单号
    ├multi_name string 门店名称
    ├can_refund int 商家是否可以退款 true-可以 false-不可以
    ├refund_id int 售后订单ID
    ├pay_mode String 支付方式
    ├verify_text String 核销内容
    ├status_text String 当前状态（文本）
    ├dispatch_type_text String 配送类型（文本）
    ├ order_type_tex String 订单类型
    ├reward_minus String 订单来源
    ├order_source Int 满减
    ├gift_card_discount Int 礼品卡优惠
    ├is_express Int 是否是快递 0-否 1-是
    ├is_newer_price Int 是否新客价
    ├count String 商品数量
    ├state Int 状态
    ├user_name String 用户名
    ├paid_amount int 退款金额
    ├items array
     ├0 array
      ├id int 订单商品id
      ├store_id int 商家ID
      ├order_id int 主订单ID
      ├data_id int 商品ID
      ├entity_id string 商品实体ID
      ├is_paid_card int 是否是付费会员卡
      ├name String 商品名称
      ├image String 商品图片
      ├price String 商品价格
      ├minus Money(元) 优惠金额
      ├num int 商品数量
      ├is_send int 是否已发货 0:未发货;1:已发货;2:已经退货
      ├sent_at int 发货时间
      ├spec String 规格
      ├messages String 商品留言
      ├freight String 运费
      ├refund_status Int 售后订单 0-没有 1-有
      ├refund Int 退款数量
      ├ext String 扩展说明
      ├product_no String 商品条码
      ├product_marking String 商品标识
      ├is_gift Int 是否赠品 0- 否 1- 是
      ├is_verified Int 是否核销 0- 未核销 1-已核销
      ├validity_period_type Int 卡券有效期类型：0 - 普通商品无效期概念 1-长期有效，2-自定义有效期
      ├brand_id String 品牌标识
      ├brand_name String 品牌名称
      ├brand_img String 品牌图片
      ├is_newer_price Int 是否新客价
      ├newer_price String 商品新客价
      ├is_limit_discount Int 是否享受限时折扣优惠
    ├user array
     ├id Int 用户id
     ├nickname String 用户名
     ├avatar String 用户头像
     ├mobile int 用户电话
   ├total int 总页数
   ├order_address array
    ├id int 用户地址数据ID
    ├user_id int 用户ID
    ├accepy_name String 收货人姓名
    ├mobile String 收货人手机号
    ├district array
     ├districts String 收货人地址-省市区
    ├street String 收货人地址-街道信息
    ├full_address String 收货人完整地址信息

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "order.list-all",
    "Params": {
        "type": "1",
        "code": "123543534",
        "pay_mode": "0",
        "limit": "10",
        "page": "1",
        "send_status": "1",
        "status": "1",
        "source": "2",
        "dispatch": "2",
        "multi_store_sn": "SN9999",
        "begin_time": "2019-05-26 00:00",
        "end_time": "2019-05-26 23:00",
        "pay_begin_time": "2019-05-26 00:00",
        "pay_end_time": "2019-05-26 23:00",
        "send_begin_time": "2019-05-26 00:00",
        "send_end_time": "2019-05-26 23:00",
        "order_no": "A5CE7A3591167A8651",
        "user_id": "123432",
        "keywords": "测试商品",
        "mobile": "",
        "pick_mobile": "",
        "pick_begin_time": "2019-05-26",
        "pick_end_time": "2019-05-28",
        "group_status": "0"
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "orders": {
            "current_page": "",
            "data": {
                "0": {
                    "id": "",
                    "store_id": "",
                    "order_no": "",
                    "user_id": "",
                    "order_type": "",
                    "status": "",
                    "total_amount": "",
                    "amount": "",
                    "refund_status": "",
                    "invoice": "",
                    "invoice_type": "",
                    "invoice_title": "",
                    "invoice_tax_code": "",
                    "refund": "",
                    "comment_status": "",
                    "completed_at": "",
                    "comment_at": "",
                    "user_remarks": "",
                    "seller_remarks": "",
                    "created_at": "",
                    "updated_at": "",
                    "ext": "",
                    "source": "",
                    "send_status": "",
                    "pay_at": "",
                    "inside_trade_no": "",
                    "payment_id": "",
                    "not_use_discount_amount": "",
                    "dispatch_type": "",
                    "pick_user": "",
                    "pick_mobile": "",
                    "self_pick_id": "",
                    "addr_id": "",
                    "freight": "",
                    "minus_amount": "",
                    "card_minus": "",
                    "coupon_discount": "",
                    "pick_at": "",
                    "multi_store_id": "",
                    "use_wallet": "",
                    "wallet_amount": "",
                    "is_invoice": "",
                    "index_stock": "",
                    "reserve_delivery_time": "",
                    "use_wallet_source": "",
                    "receive_status": "",
                    "receive_at": "",
                    "is_auto_verify": "",
                    "pick_up_time": "",
                    "third_trade_no": "",
                    "receive_point": "",
                    "cashback_order_no": "",
                    "multi_name": "",
                    "can_refund": "",
                    "refund_id": "",
                    "pay_mode": "",
                    "verify_text": "",
                    "status_text": "",
                    "dispatch_type_text": "",
                    " order_type_tex": "",
                    "reward_minus": "",
                    "order_source": "",
                    "gift_card_discount": "",
                    "is_express": "",
                    "is_newer_price": "",
                    "count": "",
                    "state": "",
                    "user_name": "",
                    "paid_amount": "",
                    "items": [
                        {
                            "id": "",
                            "store_id": "",
                            "order_id": "",
                            "data_id": "",
                            "entity_id": "",
                            "is_paid_card": "",
                            "name": "",
                            "image": "",
                            "price": "",
                            "minus": "",
                            "num": "",
                            "is_send": "",
                            "sent_at": "",
                            "spec": "",
                            "messages": "",
                            "freight": "",
                            "refund_status": "",
                            "refund": "",
                            "ext": "",
                            "product_no": "",
                            "product_marking": "",
                            "is_gift": "",
                            "is_verified": "",
                            "validity_period_type": "",
                            "brand_id": "",
                            "brand_name": "",
                            "brand_img": "",
                            "is_newer_price": "",
                            "newer_price": "",
                            "is_limit_discount": ""
                        }
                    ],
                    "user": {
                        "id": "",
                        "nickname": "",
                        "avatar": "",
                        "mobile": ""
                    }
                },
                "total": "",
                "order_address": {
                    "id": "",
                    "user_id": "",
                    "accepy_name": "",
                    "mobile": "",
                    "district": {
                        "districts": ""
                    },
                    "street": "",
                    "full_address": ""
                }
            }
        }
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

免费升级

营销功能、插件持续每月更新开发升级

免费专业培训

每月建站、微信营销、电商等互联网增值培训

7×24小时服务支持

400电话、QQ、微信、在线等多渠道售后支持

 

安徽智迈科技股份有限公司 版权所有 Copyright 2009-2018 皖公网安备 34019202000074号 增值电信业务经营许可证：皖B2-20170075