dsc.order.info.get (获取单条订单信息API)

获取单条订单信息API,获取分类相关信息。

公共参数

请求地址:
环境 HTTP请求地址 HTTPS请求地址
正式环境 http://www.xxx.com/api.php https://www.xxx.com/api.php
公共请求参数:
名称 类型 是否必须 描述
method String API接口名称
app_key String API接口AppKey

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_id Number 可选 (唯一性) 订单ID
order_sn String 可选 (唯一性) 订单编号
format type 必须 json json或xml 接口类型

响应参数

名称 类型 示例值 描述
order_id Number 订单ID
main_order_id Number 主订单ID
order_sn String 订单编号
user_id Number 会员ID
order_status Number 订单状态(0、未确认;1、已确认;2、已取消;3、无效;4、退货;5、已分单;6、部分分单;7、部分已退货;)
shipping_status Number 配送状态(0、未发货;1、已发货;2、已收货;3、备货中;4、已发货(部分商品);5、发货中(处理分单);6、已发货(部分商品);)
pay_status Number 支付状态(0、未付款;1、付款中;2、已付款;3、部分付款--预售定金;)
consignee String 收货人名称
country Number 1 国家
province Number 省份
city Number 市级
district Number 区县
street Number 街道乡镇
address String 收货详细地址
zipcode Number 邮政编码
tel Number 联系电话
mobile Number 联系手机号码
email String 邮箱地址
sign_building String 添加时间
postscript String 订单附言
shipping_id Number 配送方式ID
shipping_code String 配送方式代码
shipping_type Number 配送类型(0-配送,1-自提)
pay_id Number 支付方式ID
pay_name String 支付方式名称
how_oos String 缺货处理方式,等待所有商品备齐后再发; 取消订单;与店主协商
inv_payee String 发票抬头
inv_content String 发票内容
pack_name String 包装名称
card_name String 贺卡的名称
card_message String 贺卡内容,由用户提交
goods_amount float 商品总金额
shipping_fee float 配送费用
insure_fee float 保价费用
pay_fee float 支付费用
pack_fee float 包装费用
card_fee float 贺卡费用发票抬头,用户页面填写
money_paid float 已付款金额
surplus float 使用余额
integral Number 使用积分
integral_money float 使用积分金额
bonus float 使用红包金额
order_amount float 订单总金额
from_ad String 广告ID(订单来源)
referer String 订单来源页面
add_time String 下单时间
confirm_time String 订单确认时间
pay_time String 订单付款时间
shipping_time String 订单配送时间
auto_delivery_time String 自动确认订单时间(天数)
pack_id Number 包装ID
card_id Number 贺卡ID
bonus_id Number 红包ID
invoice_no String 发货单号
extension_code String 通过活动购买的商品的代号;团购:group_buy,拍卖;auction, 夺宝奇兵;snatch,批发;wholesale,秒杀;seckill,积分商城;exchange_goods,预售;presale,正常普通产品该处为空
extension_id Number 通过活动购买的物品的id,取值dsc_goods_activity;如果是正常普通商品,该处为0
to_buyer String 商家给客户的留言,当该字段有值时可以在订单查询看到
pay_note String 付款备注,在后台订单管理里编辑修改
agency_id Number 该笔订单被指派给的办事处的id,根据订单内容和办事处负责范围自动决定,也可以有管理员修改,取值于表dsc_agency
inv_type String 发票类型,用户页面选择,取值ecs_shop_config的code字段的值为invoice_type的value
tax float 发票税额
is_separate Number 0,未分成或等待分成;1,已分成;2,取消分成
parent_id Number 能获得推荐分成的用户id,
discount float 折扣金额
coupons float 优惠券金额
discount_all float 分单时记录红包总金额
is_delete Number 操作删除订单状态(0为删除,1删除回收站,2会员订单列表不显示该订单信息)
point_id Number 自提编号
shipping_dateStr String 自提时间
supplier_id Number 供货商ID
froms String pc:电脑,mobile:手机,app:应用

请求示例

  • PHP
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.order.info.get&order_sn=2017022113253975600&format=xml"
$Http = new Http();
$Http->doGet($url);

响应示例

  • XML
  • JSON
<dsc>
<info>
<order_id>34</order_id>
<order_sn>2017022113253975600</order_sn>
<order_status>1</order_status>
<shipping_status>0</shipping_status>
<pay_status>2</pay_status>
<consignee>ecmoban5</consignee>
<country>1</country>
<province>25</province>
<city>321</city>
<district>2709</district>
<street>3414</street>
<address>中山北路3553号伸大厦3层301</address>
<mobile>18321020600</mobile>
<shipping_id>9</shipping_id>
<shipping_code>申通快递</shipping_code>
<shipping_type>0</shipping_type>
<pay_id>2</pay_id>
<pay_name>银行汇款/转帐</pay_name>
<inv_payee>个人</inv_payee>
<inv_content>不开发票</inv_content>
<goods_amount>190.00</goods_amount>
<shipping_fee>7.30</shipping_fee>
<insure_fee>0.00</insure_fee>
<pay_fee>0.00</pay_fee>
<pack_fee>0.00</pack_fee>
<card_fee>0.00</card_fee>
<money_paid>77.30</money_paid>
<surplus>100.00</surplus>
<integral>200</integral>
<integral_money>20.00</integral_money>
<bonus>0.00</bonus>
<order_amount>0.00</order_amount>
<add_time>1487625933</add_time>
<confirm_time>1487625993</confirm_time>
<pay_time>1487626014</pay_time>
<invoice_no>123456789</invoice_no>
<tax>0.00</tax>
<froms>pc</froms>
</info>
</dsc>
{
"info": {
"order_id": "34",
"order_sn": "2017022113253975600",
"order_status": "1",
"shipping_status": "0",
"pay_status": "2",
"consignee": "ecmoban5",
"country": "1",
"province": "25",
"city": "321",
"district": "2709",
"street": "3414",
"address": "中山北路3553号伸大厦3层301",
"mobile": "18321020600",
"shipping_id": "9",
"shipping_code": "申通快递",
"shipping_type": "0",
"pay_id": "2",
"pay_name": "银行汇款/转帐",
"inv_payee": "个人",
"inv_content": "不开发票",
"goods_amount": "190.00",
"shipping_fee": "7.30",
"insure_fee": "0.00",
"pay_fee": "0.00",
"pack_fee": "0.00",
"card_fee": "0.00",
"money_paid": "77.30",
"surplus": "100.00",
"integral": "200",
"integral_money": "20.00",
"bonus": "0.00",
"order_amount": "0.00",
"add_time": "1487625933",
"confirm_time": "1487625993",
"pay_time": "1487626014",
"invoice_no": "123456789",
"tax": "0.00",
"froms": "pc",
}
}

异常示例

  • XML
  • JSON
<dsc>
<result>success</result>
<error>0</error>
<msg>成功获取数据</msg>
</dsc>
{
"result": "success",
"error": 0,
"msg": "成功获取数据",
}

错误码解释

错误码 错误描述 解决方案
error 返回值

0:成功获取数据

1:数据为空值

2:条件为空或参数不存在

返回
顶部