订单。

API

.get(order_no, callback)获取指定订单.get([config,] callback)获取订单列表.receive(order, callback)指定订单的指定运单确认收货.create(order, callback)提交订单 （必须登录）.create(order, callback)匿名提交订单（免登录下单），默认使用离线购物车.cancel(order, callback)取消指定订单.count([config,] callback)获取指定状态订单的数量

.get(order_no, callback)

获取指定订单

• • order_no
  • 类型：String
    指定订单编号
    未登录时调用此接口，将返回指定订单的简单详情。
• • callback
  • 类型：Function( 返回对象 )
    获取信息后的回调函数

.get([config,] callback)

获取订单列表

• • config
  • 类型：Object
    • order_nos 类型：String 选填
      指定多个订单编号，以“,”分隔
    • status 类型：Number 选填
      指定订单状态，
      0 - 订单进行中
      1 - 订单取消
      2 - 订单退单申请处理中
      3 - 订单退单完成
      4 - 订单完成
      5 - 支付过期
    • shipment_status 类型：Number 选填
      指定物流状态，
      0 - 未发货
      1 - 已发货
      2 - 已签收
      3 - 部分发货
    • payment_status 类型：Number 选填
      指定支付状态，
      0 - 未付款
      1 - 货到付款（已弃用，统一为 2）
      2 - 付款成功
      3 - 付款超时
    • size 类型：Number
      指定返回每页的数目
    • page 类型：Number
      指定返回分页页码
• • callback
  • 类型：Function( 返回对象 )
    获取信息后的回调函数
    返回对象中包含分页对象 paging 查看详情

.receive(order, callback)

指定订单的指定运单确认收货

• • order
  • 类型：Object
    • order_no 类型：String
      指定订单编号
    • shipment_id 类型：String
      指定运单编号
• • callback
  • 类型：Function( 返回对象 )
    提交后的回调函数

.create(order, callback)

提交订单 （必须登录）

• • order
  • 类型：Object
    • address_id 类型：Number
      收货人信息id
    • payment_method_id 类型：Number
      支付方式id
    • bank_code_id（选填） 类型：Number
      支付银行id，当 payment_method_id 为银行卡支付方式时必填
    • remark（选填） 类型：String
      订单备注
    • shipments 类型：Json
      配送方式Json对象。例如：
      [{"id":59,"shipment_method_id":90},{"id":61,"shipment_method_id":81}]
    • coupon_code（选填） 类型：String
      优惠券编码
    • reward_point（选填） 类型：Number
      使用的积分数量
    • meta_fields（选填） 类型：Json
      拓展订单对象数据Json对象，参考 Metafields API
      • name（必填） 类型：String
        Metafield 的唯一字符串标识
        特殊值order_attributes，此时fields内的键值对将会展示在“管理后台-订单详情-附加信息”里
      • description（必填） 类型：String
        Metafield 的说明，最多 2000 个字符
      • fields（必填） 类型：Object
        Metafield 的字段，Key-Value 结构对象
• • callback
  • 类型：Function( 返回对象 )
    提交后的回调函数

.create(order, callback)

匿名提交订单（免登录下单），默认使用离线购物车

• • order
  • 类型：Object
    • items（选填） 类型：Json
      该订单包含的商品。如果使用此参数，则不使用离线购物车的数据。例如：
      [{"variant_id":17,"quantity":1},{"variant_id":992,"quantity":2}]
    • name 类型：String 长度：255
      收货人姓名
    • district_code 类型：String 长度：255
      收货区域编码（最后一级）
    • detail 类型：String 长度：255
      详细收货地址
    • zipcode（选填） 类型：String 长度：255
      邮编
    • mobile 类型：String 长度：255
      移动电话号码
    • telephone（选填） 类型：String 长度：255
      联系电话
    • email（选填） 类型：String 长度：255
      邮箱
    • payment_method_id 类型：Number
      支付方式id
    • bank_code_id（选填） 类型：Number
      支付银行id，当 payment_method_id 为银行卡支付方式时必填
    • remark（选填） 类型：String
      订单备注。
    • shipments 类型：Json
      配送方式Json对象。例如：
      [{"id":59,"shipment_method_id":90},{"id":61,"shipment_method_id":81}]
    • coupon_code（选填） 类型：String
      优惠券编码
    • reward_point（选填） 类型：Number
      使用的积分数量
    • meta_fields（选填） 类型：Json
      拓展订单对象数据Json对象，参考 Metafields API
      • name（必填） 类型：String
        Metafield 的唯一字符串标识
        特殊值order_attributes，此时fields内的键值对将会展示在“管理后台-订单详情-附加信息”里
      • description（必填） 类型：String
        Metafield 的说明，最多 2000 个字符
      • fields（必填） 类型：Object
        Metafield 的字段，Key-Value 结构对象
• • callback
  • 类型：Function( 返回对象 )
    提交后的回调函数

.cancel(order, callback)

取消指定订单

• • order
  • 类型：Object
    • order_no 类型：String
      指定订单编号
    • reason 类型：String
      退单理由
• • callback
  • 类型：Function( 返回对象 )
    提交后的回调函数

.count([config,] callback)

获取指定状态订单的数量

• • config
  • 类型：Object
    • status 类型：Number 选填
      指定订单状态，取值参考 order.get([config,] callback)
    • shipment_status 类型：Number 选填
      指定物流状态，取值参考 order.get([config,] callback)
    • payment_status 类型：Number 选填
      指定物流状态，取值参考 order.get([config,] callback)
      例如：
      payment_status=0&status=0 - 待付款
      payment_status=2&shipment_status=0,3 - 待发货
      shipment_status=1 - 待收货
• • callback
  • 类型：Function( 返回对象 )
    提交后的回调函数