eBay大中华区API开发者平台 开发者专区

搜 索

eBay大中华卖家API简介

发布时间:2017-02-09


为了更好的支持eBay大中华区卖家的业务运营和拓展,我们特别研发了API接口产品,方便卖家将其eBay帐号下的转化率,Defect不良交易及本土政策等数据整合进自己的工具或系统中。该API接口产品所调取的数据来自eBay公司的阶段性数据, eBay公司及编制人员对该等数据的准确性和完整性不作任何保证,也不保证所包含的信息和建议不会发生任何变更。数据中的任何(包括隐含的)观点、建议、结论等仅供参考,不够成对您的终操作的建议,eBay公司不就报告中的内容等对您的终操作等做出任何保证或者承诺,您据此做出的任何决策与eBay公司无关。***期开放的数据主要包含Item Best Matches转化率分析,包括但是不限于曝光量、浏览量和成交量相关基本信息,我们会随着市场反馈,对该API产品支持的数据不断进行扩充。


注:
1. 本API采用eBay新Oauth token验证,和原有Auth'n'Auth Token不通用,详细参照如下说明。
2. 本API的调用次数单独统计,不影响你目前API的使用。

所有服务

数据名称 简介 流量控制 详细
大中华帐户政策状态接口 HOT
GET /gccbtapi/v1/dashboard/account_data 获取卖家帐户全量的政策状态及详细数据,包含以下全部政策状态及详情数据。 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/account_overview 获取卖家帐户所有适用的政策状态,但不包含详细数据。卖家可以根据状态选择查看对应帐号的卖家中心查看详情。 500000 / 每天 / 每个App view
GET /gccbtapi/v1/defect_transaction/account 政策细分:不良交易表现>状态总览数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/defect_transaction/diagnosis 政策细分:不良交易表现>状态总览数据>不良交易率细分数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/defect_transaction/listings 政策细分:不良交易表现>不良交易刊登/待处理刊登数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/hkmandate/account 政策细分:从中国香港寄出直邮交易物流服务使用政策状态接口 500000 / 每天 / 每个App view
GET /gccbtapi/v1/hkmandate/listings 政策细分:从中国香港寄出直邮交易物流服务使用政策相关交易下载数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/seller_inr 政策细分:获取买家未收到物品提醒信息列表 500000 / 每天 / 每个App view
GET /gccbtapi/v2/overseas_warehouses/acct_data  政策细分:获取海外仓标准的状态及详细数据 500000 / 每天 / 每个App view
GET /gccbtapi/v2/overseas_warehouses/trans_data 政策细分:海外仓服务标准政策相关交易是数据下载接口 500000 / 每天 / 每个App view
GET /gccbtapi/v1/speedPak/list_data 政策细分:获取SpeedPAK 物流管理方案及其他符合政策要求的物流服务使用状态数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/speedPak/list_download 政策细分:获取SpeedPAK 物流管理方案及其他符合政策要求的物流服务使用状态相关交易下载数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/speedPak/misuse_data 政策细分:买家选择SpeedPAK物流选项时卖家正确使用SpeedPAK物流管理方案表现数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/speedPak/misuse_download 政策细分:买家选择SpeedPAK物流选项时卖家正确使用SpeedPAK物流管理方案表现相关交易下载数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/directshipping/acct_data 政策细分:直邮/所有交易可追踪服务使用情况接口 500000 / 每天 / 每个App view
GET /gccbtapi/v1/directshipping/trans_download 政策细分:直邮/所有交易可追踪服务使用情况相关交易下载接口 500000 / 每天 / 每个App view
GET /gccbtapi/v1/policy/account?policyName=cwssp 政策细分:eBay对接仓使用率要求接口 500000 / 每天 / 每个App view
GET /gccbtapi/v1/policy/listings?policyName=cwssp 政策细分:eBay对接仓使用率要求相关交易下载接口 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/epacket_shipping_policy (已停用) 政策细分: 获取物流标准政策--美国>$5交易的物流使用状态及详细数据。 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/ltnp (已停用) 政策细分:获取综合表现状态及详细数据 500000 / 每天 / 每个App view
GET /gccbtapi/v2/nonshipping/snad/acct (已停用) 政策细分:获取物品与描述不符纠纷状态及详细数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/pgc_tracking (已停用) 政策细分:获取商业计划追踪表现的状态及详细数据 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/qclist (已停用, 整合到GET /gccbtapi/v1/defect_transaction/listings ) 政策细分:获取待处理刊登列表的信息 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/ship1to12 (已停用) 政策细分:获取货运表现的状态及详细数据 500000 / 每天 / 每个App view
不良交易刊登(Defect listing)接口 (已停用,整合到GET /gccbtapi/v1/defect_transaction/trans_data
GET /gccbtapi/v2/nonshipping/snad/listings (已停用) 导致物品与描述不符纠纷表现问题的刊登列表 500000 / 每天 / 每个App view
GET /gccbtapi/v1/dashboard/defectListings/ship1to12 (已停用) 导致货运表现问题的刊登列表 500000 / 每天 / 每个App view
Item Best Matches 转化率分析接口(内部测试中)
GET /gccbtapi/v1/item_best_matches 获取卖家刊登在某个时段内的基于Best Match 排名的转化率数据 500000 / 每天 / 每个App view
"额度申请快速通道"状态查询接口
GET /gccbtapi/v1/limit_adjustment/check 获取卖家帐户是否符合提额条件的状态查询 500000 / 每天 / 每个App view
其它数据支持持续更新中

服务器地址

Sandbox:    https://gccbtapi.sandbox.ebay.com.hk
Production: https://gccbtapi.ebay.com.hk

获取UserToken

以Sandbox为例,拿Token总共两步:


第一步,获取code:
https://signin.sandbox.ebay.com/authorize?client_id=LinusYan-OAuthCli-SBX-845f30466-db4b5eda&redirect_uri=Linus_Yan-LinusYan-OAuthC-tvljqs&response_type=code&state=null&scope=https%3A%2F%2Fapi.ebay.com%2Foauth%2Fapi_scope%2Fsell.analytics.readonly


注意点:

• 参数client_id和redirect_uri都是必须的,用户需自己替换自己Sandbox的配置。
• 参数response_type必须是code。
• scope是必须的,而且用encodeComponent()编码,如果有多个值,这些值得用空格分开,然后再编码。访问ItemBestMatch,scope必须包含https%3A%2F%2Fapi.ebay.com%2Foauth%2Fapi_scope%2Fsell.analytics.readonly。

用户登录授权之后,在跳转URL中可获取code,这个code是被编码的,不需要解码。如果是后台服务器拿到的,可能已经被解码了,需要重新用encodeComponent()编码才能传到第二步使用。


第二步,拿到code之后,获取Token:
https://api.sandbox.ebay.com/identity/v1/oauth2/token?grant_type=authorization_code&redirect_uri=Linus_Yan-LinusYan-OAuthC-tvljqs&code=v%5E1.1%23i%5E1%23f%5E0%23p%5E3%23I%5E3%23r%5E1%23t%5EUl4xX0NGMzc5REU0MjJDQ0Y5REE1QjYzREFCQUU1QTBGM0Y0XzNfMSNFXjEyODQ%3D


注意点:

• 参数grant_type固定是authorization_code.
• 参数redirect_uri和第一步的redirect_uri是一样的。
• 参数code来源于用户授权之后的跳转URL。

更多详情,请参考Global API文档:https://developer.ebay.com/devzone/rest/ebay-rest/content/oauth-gen-user-token.html,如果拿不到,说明没有按文档正确配置。尤其要注意,有两个环境,一个是Sandbox,一个是Production

其他通用设置

• HTTP请求头

所有发送到eBay REST服务的请求都需要提供authorization请求头以获取验证信息。 Authorization请求头的格式为:Bearer + 空格 + Token。具体详情请参考: HTTP request headers

• OAuth请求域和Token

eBay开发了一套新的Global API,并使用了新的OAuth Token。请注意,这和Trading API的Token是不兼容的,Trading API的Token不能用于访问新的API。关于如何获取新的OAuth Token,请参考:Getting Access Tokens


另一个需要注意的是:新的Token中授权了用户可以访问的范围,这个范围eBay称之为scope(域),用户只能访问token中指定scope的资源,否则会返回错误。参数scope在申请授权码的时候指定,用户登录授权之后,应用根据授权码拿到新的Token,此时这些scopes就隐藏在Token之中了。


访问ItemBestMatches服务,需要用户的访问Token至少包含这个域: https://api.ebay.com/oauth/api_scope/sell.analytics.readonly



* 常见错误信息