淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
auto_fforder_pull_param	AutoFFOrderPullParam	必须			自动化履约拉取
└ user_token String 必须 userToken_用于找商家中心验证登录态商家token └ auto_fforderid_list String [] 必须 FF-123 自动化履约单ID

名称	类型	示例值	描述
result	AutoFFOrderDetailBO []		自动履约单
└ auto_ff_order_id String FF-45884 自动化履约单ID └ auto_fforder_status Number 100 自动化履约单状态 └ auto_fforder_status_name String 待拉取处理状态名称 └ order_id String 1234567896584145 订单号 └ ticket_system_order_id String 1234567896584145 生产系统订单号，票务云主订单号 └ perform_city_name String 北京演出城市 └ project_id String 1478523698 项目id └ project_name String XXX演唱会项目名称 └ perform_start_time Date 2024-05-20 15:30:00 演出开始时间 └ venue_name String xxx展览馆场馆名称 └ ticket_count Number 1 票张数 └ seat_info String 一楼 · 9排 · 22号座位信息 └ result_time Date 2024-05-20 15:30:00 处理结果时间 auto_fforder_waybill_bo AutoFFOrderWaybillBO 运单信息 └ waybill_no String 13486746876 运单号 └ ems_product_no String 特快专递 ems产品名称 └ ems_route_code String 123456789 EMS分拣码 └ ems_cargo_name String 大麦票 ems货物名称 └ ems_cargo_info String 大麦票1张 ems货物信息 └ ems_waybill_remark String 集团重点客户，晚点追责，需本人签收，转寄快件需与寄件方核实，确认后方可转寄。运单备注 └ sender_name String 李四发件人名称 └ sender_phone String 12374128965 发件人电话 └ sender_address String XX省XX市XX区XX街道XX号发件人地址 └ receiver_name String 王二收件人名称 └ receiver_mobile String 12374589654 收件人手机号 └ receiver_address String XX省XX市XX区XX街道XX号收件人地址 └ order_pay_time Date 2024-05-20 15:30:00 订单支付时间 └ perform_id String 1234567890 场次ID
is_success	Boolean	true	是否成功
error_code_str	String	100001	错误码
error_msg_str	String	失败	错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiOrderffAutoPullRequest req = new AlibabaDamaiOrderffAutoPullRequest();
AlibabaDamaiOrderffAutoPullRequest.AutoFFOrderPullParam obj1 = new AlibabaDamaiOrderffAutoPullRequest.AutoFFOrderPullParam();
obj1.setUserToken("userToken_用于找商家中心验证登录态");
obj1.setAutoFforderidList("FF-123");
req.setAutoFforderPullParam(obj1);
AlibabaDamaiOrderffAutoPullResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiOrderffAutoPullRequest req = new AlibabaDamaiOrderffAutoPullRequest();
AlibabaDamaiOrderffAutoPullRequest.AutoFFOrderPullParamDomain obj1 = new AlibabaDamaiOrderffAutoPullRequest.AutoFFOrderPullParamDomain();
obj1.UserToken = "userToken_用于找商家中心验证登录态";
obj1.AutoFforderidList = "FF-123";
req.AutoFforderPullParam_ = obj1;
AlibabaDamaiOrderffAutoPullResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiOrderffAutoPullRequest;
$auto_fforder_pull_param = new AutoFFOrderPullParam;
$auto_fforder_pull_param->user_token="userToken_用于找商家中心验证登录态";
$auto_fforder_pull_param->auto_fforderid_list="FF-123";
$req->setAutoFforderPullParam(json_encode($auto_fforder_pull_param));
$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=alibaba.damai.orderff.auto.pull' \
-d 'partner_id=apidoc' \
-d 'sign=D0C98FE9F3C2DBA2984C99AB4BDDE2C6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-01+20%3A17%3A49' \
-d 'v=2.0' \
-d 'auto_fforder_pull_param=null'

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

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

req.auto_fforder_pull_param="数据结构示例JSON格式"
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,"alibaba.damai.orderff.auto.pull");
add_param(pRequest,"auto_fforder_pull_param","数据结构JSON示例");
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('alibaba.damai.orderff.auto.pull', {
	'auto_fforder_pull_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_orderff_auto_pull_response>
    <result>
        <auto_f_f_order_detail_b_o>
            <auto_ff_order_id>FF-45884</auto_ff_order_id>
            <auto_fforder_status>100</auto_fforder_status>
            <auto_fforder_status_name>待拉取</auto_fforder_status_name>
            <order_id>1234567896584145</order_id>
            <ticket_system_order_id>1234567896584145</ticket_system_order_id>
            <perform_city_name>北京</perform_city_name>
            <project_id>1478523698</project_id>
            <project_name>XXX演唱会</project_name>
            <perform_start_time>2024-05-20 15:30:00</perform_start_time>
            <venue_name>xxx展览馆</venue_name>
            <ticket_count>1</ticket_count>
            <seat_info>一楼 · 9排 · 22号</seat_info>
            <result_time>2024-05-20 15:30:00</result_time>
            <auto_fforder_waybill_bo>
                <waybill_no>13486746876</waybill_no>
                <ems_product_no>特快专递</ems_product_no>
                <ems_route_code>123456789</ems_route_code>
                <ems_cargo_name>大麦票</ems_cargo_name>
                <ems_cargo_info>大麦票1张</ems_cargo_info>
                <ems_waybill_remark>集团重点客户，晚点追责，需本人签收，转寄快件需与寄件方核实，确认后方可转寄。</ems_waybill_remark>
                <sender_name>李四</sender_name>
                <sender_phone>12374128965</sender_phone>
                <sender_address>XX省XX市XX区XX街道XX号</sender_address>
                <receiver_name>王二</receiver_name>
                <receiver_mobile>12374589654</receiver_mobile>
                <receiver_address>XX省XX市XX区XX街道XX号</receiver_address>
            </auto_fforder_waybill_bo>
            <order_pay_time>2024-05-20 15:30:00</order_pay_time>
            <perform_id>1234567890</perform_id>
        </auto_f_f_order_detail_b_o>
    </result>
    <is_success>true</is_success>
    <error_code_str>100001</error_code_str>
    <error_msg_str>失败</error_msg_str>
</alibaba_damai_orderff_auto_pull_response>

{
    "alibaba_damai_orderff_auto_pull_response":{
        "result":{
            "auto_f_f_order_detail_b_o":[
                {
                    "auto_ff_order_id":"FF-45884",
                    "auto_fforder_status":100,
                    "auto_fforder_status_name":"待拉取",
                    "order_id":"1234567896584145",
                    "ticket_system_order_id":"1234567896584145",
                    "perform_city_name":"北京",
                    "project_id":"1478523698",
                    "project_name":"XXX演唱会",
                    "perform_start_time":"2024-05-20 15:30:00",
                    "venue_name":"xxx展览馆",
                    "ticket_count":1,
                    "seat_info":"一楼 · 9排 · 22号",
                    "result_time":"2024-05-20 15:30:00",
                    "auto_fforder_waybill_bo":{
                        "waybill_no":"13486746876",
                        "ems_product_no":"特快专递",
                        "ems_route_code":"123456789",
                        "ems_cargo_name":"大麦票",
                        "ems_cargo_info":"大麦票1张",
                        "ems_waybill_remark":"集团重点客户，晚点追责，需本人签收，转寄快件需与寄件方核实，确认后方可转寄。",
                        "sender_name":"李四",
                        "sender_phone":"12374128965",
                        "sender_address":"XX省XX市XX区XX街道XX号",
                        "receiver_name":"王二",
                        "receiver_mobile":"12374589654",
                        "receiver_address":"XX省XX市XX区XX街道XX号"
                    },
                    "order_pay_time":"2024-05-20 15:30:00",
                    "perform_id":"1234567890"
                }
            ]
        },
        "is_success":true,
        "error_code_str":"100001",
        "error_msg_str":"失败"
    }
}

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"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

大麦API

alibaba.damai.orderff.auto.pull (自动化履约 - 订单拉取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ