文档中心 > 综合交通-商家对接

qimen.alitrip.bus.product.scancode.getgoodsdetail (获取扫码购票商品数据)

查询扫码票车次信息接口。根据商家二维码url中给定的goodsId商品id查询，返回线路名称、出发到达地点、车牌号、发车时间、票价等车次信息。本接口主要目的渲染下单页展示给用户，以供用户查看商品进行下单。返回参数中agentOrderId代表商家内部的订单号，一个agentOrderId代表一笔订单，每次调用此接口查询商品信息需返回不同的订单号，不允许重复。

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
goodsId	String	必须	goods123		商品id

响应参数

名称	类型	示例值	描述
ret_code	String	0	业务结果编码
ret_desc	String	成功	业务结果描述
success	String	true	业务结果
goodsdetail	GoodsDetail		商品信息
└ tradeSource String window 扫码场景：window:窗口扫码;self:车上扫码 └ agentOrderId String 1234567890 商家订单号，必传 └ lineCode String 206 线路编号 └ lineName String 梅溪湖-火车站线路名称 └ startProvince String 江苏出发省份 └ startCity String 苏州出发城市 └ startStation String 梅溪湖出发站，当车牌号为空时必传 └ endProvince String 浙江到达省份 └ endCity String 杭州到达城市 └ endStation String 火车站到达站，当车牌号为空时必传 └ plateNum String 京A12345 车牌号，当出发到达车站为空时必传 └ departureTime String 2021-01-01 12:00:00 发车时间 └ billModel String keypad 计费模式，固定票价：base，分段票价：keypad，区间价interval，必传 └ basePrice Number 100 固定票价，单位/分，当计费模式为固定票价时必传 └ keypadPayList String 1,3,5,6,8 分段票价，单位/分，多个金额用逗号隔开，当计费模式为区间票价是必传 └ intervalPrice String 1,10 区间价，单位/分，多个金额用逗号隔开，当计费模式为区间价时必传 └ intervalMode String ticket(默认值) 区间价售卖类型：ticket-票维度售卖；order-订单维度票价。当计费模式为区间价时必传 └ driverName String 小王司机姓名 └ driverAccount String driver01 司机账号 └ driverPhone String 18812341234 司机手机号 └ departureNumber String 001 发车班次

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlitripBusProductScancodeGetgoodsdetailRequest req = new AlitripBusProductScancodeGetgoodsdetailRequest();
req.setGoodsId("goods123");
AlitripBusProductScancodeGetgoodsdetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripBusProductScancodeGetgoodsdetailRequest req = new AlitripBusProductScancodeGetgoodsdetailRequest();
req.GoodsId = "goods123";
AlitripBusProductScancodeGetgoodsdetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripBusProductScancodeGetgoodsdetailRequest;
$req->setGoodsId("goods123");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=qimen.alitrip.bus.product.scancode.getgoodsdetail' \
-d 'partner_id=apidoc' \
-d 'sign=50B1FE50E3A65B4B8FC9FF72FA7580F8' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-04-27+23%3A20%3A43' \
-d 'v=2.0' \
-d 'goodsId=goods123'

# -*- coding: utf-8 -*-
import top.api

req=top.api.QimenAlitripBusProductScancodeGetgoodsdetailRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.goodsId="goods123"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"qimen.alitrip.bus.product.scancode.getgoodsdetail");
add_param(pRequest,"goodsId","goods123");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('qimen.alitrip.bus.product.scancode.getgoodsdetail', {
	'goodsId':'goods123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<ret_code>0</ret_code>
<ret_desc>成功</ret_desc>
<success>true</success>
<goodsdetail>
    <tradeSource>window</tradeSource>
    <agentOrderId>1234567890</agentOrderId>
    <lineCode>206</lineCode>
    <lineName>梅溪湖-火车站</lineName>
    <startProvince>江苏</startProvince>
    <startCity>苏州</startCity>
    <startStation>梅溪湖</startStation>
    <endProvince>浙江</endProvince>
    <endCity>杭州</endCity>
    <endStation>火车站</endStation>
    <plateNum>京A12345</plateNum>
    <departureTime>2021-01-01 12:00:00</departureTime>
    <billModel>keypad</billModel>
    <basePrice>100</basePrice>
    <keypadPayList>1,3,5,6,8</keypadPayList>
    <intervalPrice>1,10</intervalPrice>
    <intervalMode>ticket(默认值)</intervalMode>
    <driverName>小王</driverName>
    <driverAccount>driver01</driverAccount>
    <driverPhone>18812341234</driverPhone>
    <departureNumber>001</departureNumber>
</goodsdetail>

{
    "ret_code":"0",
    "ret_desc":"成功",
    "success":"true",
    "goodsdetail":{
        "tradeSource":"window",
        "agentOrderId":"1234567890",
        "lineCode":"206",
        "lineName":"梅溪湖-火车站",
        "startProvince":"江苏",
        "startCity":"苏州",
        "startStation":"梅溪湖",
        "endProvince":"浙江",
        "endCity":"杭州",
        "endStation":"火车站",
        "plateNum":"京A12345",
        "departureTime":"2021-01-01 12:00:00",
        "billModel":"keypad",
        "basePrice":100,
        "keypadPayList":"1,3,5,6,8",
        "intervalPrice":"1,10",
        "intervalMode":"ticket(默认值)",
        "driverName":"小王",
        "driverAccount":"driver01",
        "driverPhone":"18812341234",
        "departureNumber":"001"
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案
isp.http-connection-timeout

开放平台

综合交通-商家对接

qimen.alitrip.bus.product.scancode.getgoodsdetail (获取扫码购票商品数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ