taobao.jipiao.agent.order.search (【机票代理商订单】订单搜索)

卖家根据条件查询淘宝订单id列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
begin_time Date 可选 2000-01-01 00:00:00 创建订单时间范围的开始时间,注意:当前搜索条件开始结束时间范围不能超过三天,默认开始时间为当前时间往前推三天 (具体天数可能调整)
end_time Date 可选 2000-01-01 00:00:00 创建订单时间范围的结束时间,注意:当前搜索条件开始结束时间范围不能超过三天,默认为当前时间 (具体天数可能调整)
status Number 可选 1 订单状态,默认为空,查询所有状态的订单 1:待确认 2:待出票 3:强制成功 4:未付款 5:预订成功 6:已失效
trip_type Number 可选 0 航程类型: 0.单程;1.往返
has_itinerary Boolean 可选 true 是否需要行程单,true表示需要行程单;false表示不许要
page Number 可选 1 页码,默认第一页;注意:页大小固定,搜索结果中返回页大小pageSize,和是否包含下一页hasNext
extra String 可选 {"needFilterAutobook": true } 扩展字段: needFilterAutobook:默认true。待出票状态下,会根据此值过滤掉自动出票状态下订单,以防止重复出票的问题。对于精选票,此值需要设置成false,并由API使用者保证不会重复出票。

响应参数

名称 类型 示例值 描述
is_success Boolean true 返回操作成功失败信息
error_message String 系统异常 失败时的错误信息
search_result SearchOrderResult 机票订单搜索返回结果对象
  • └ order_ids
  • Number []
  • 100
  • 淘宝机票订单列表
  • └ page_size
  • Number
  • 1000
  • 当前淘宝系统设定的搜索结果页大小,即支持一次最多返回订单条数
  • └ has_next
  • Boolean
  • true
  • 是否还有下一页,即满足搜索条件的订单数是否还有下一个分页

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
JipiaoAgentOrderSearchRequest req = new JipiaoAgentOrderSearchRequest();
req.setBeginTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setEndTime(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setStatus(1L);
req.setTripType(0L);
req.setHasItinerary(true);
req.setPage(1L);
req.setExtra("{\"needFilterAutobook\": true }");
JipiaoAgentOrderSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<jipiao_agent_order_search_response>
    <is_success>true</is_success>
    <error_message>系统异常</error_message>
    <search_result>
    </search_result>
</jipiao_agent_order_search_response>

异常示例

  • 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>

错误码解释

错误码 错误描述 解决方案
isv.invalid-parameter:error 参数不正确+错误参数信息 根据文档设置参数
isv.remote-service-error 系统错误+错误的原因 需要向运营咨询
isv.remote-service-error:NO_DATA 订单数据不存在 确认查询条件,调整查询条件
isv.remote-service-error:USER_AUTH_FAIL 访问权限不够,Appkey未授权或者Appkey绑定非授权用户 需要向运营咨询处理方案

API工具

如何获得此API

FAQ

返回
顶部