Skip to main content
GET
eBay Search API -test

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

查询参数

advanced_filters
string

Comma-separated list of advanced filters in key=value format

buying_format
enum<string>

Buying format filter

可用选项:
auction,
buy_it_now,
best_offer
category_id
integer

Category ID to search within. Either 'q' or 'category_id' must be present

condition
string

Comma-separated list of item conditions

Pattern: ^(new|new_opened|like_new|new_with_defects|pre_owned_fair|pre_owned_excellent|used_very_good|used_good|used_acceptable|certified_refurbished|excellent_refurbished|very_good_refurbished|good_refurbished|seller_refurbished|for_parts_or_not_working|not_specified)(,(new|new_opened|like_new|new_with_defects|pre_owned_fair|pre_owned_excellent|used_very_good|used_good|used_acceptable|certified_refurbished|excellent_refurbished|very_good_refurbished|good_refurbished|seller_refurbished|for_parts_or_not_working|not_specified))*$
country
enum<string>

ISO 3166-1 alpha-2 country code

可用选项:
US,
CA,
GB,
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BR,
VG,
BN,
BG,
BF,
BI,
KH,
CM,
CV,
KY,
CF,
TD,
CL,
CN,
CO,
KM,
CD,
CG,
CK,
CR,
CI,
HR,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FJ,
FI,
FR,
GF,
PF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KR,
KW,
KG,
LA,
LV,
LB,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NO,
OM,
PK,
PW,
PA,
PG,
PY,
PE,
PH,
PL,
PT,
PR,
QA,
RO,
RU,
RW,
SH,
KN,
LC,
PM,
VC,
SM,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
ES,
LK,
SR,
SZ,
SE,
CH,
TW,
TJ,
TZ,
TH,
TG,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
UY,
UZ,
VU,
VA,
VE,
VN,
VI,
WF,
EH,
WS,
YE,
FM,
RE,
ME,
RS
delivery_country
enum<string>

Delivery country ISO 3166-1 alpha-2 code

可用选项:
US,
CA,
GB,
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BR,
VG,
BN,
BG,
BF,
BI,
KH,
CM,
CV,
KY,
CF,
TD,
CL,
CN,
CO,
KM,
CD,
CG,
CK,
CR,
CI,
HR,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FJ,
FI,
FR,
GF,
PF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KR,
KW,
KG,
LA,
LV,
LB,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NO,
OM,
PK,
PW,
PA,
PG,
PY,
PE,
PH,
PL,
PT,
PR,
QA,
RO,
RU,
RW,
SH,
KN,
LC,
PM,
VC,
SM,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
ES,
LK,
SR,
SZ,
SE,
CH,
TW,
TJ,
TZ,
TH,
TG,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
UY,
UZ,
VU,
VA,
VE,
VN,
VI,
WF,
EH,
WS,
YE,
FM,
RE,
ME,
RS
distance_radius
number

Distance radius in miles from postal code. Requires postal code to be set

必填范围: x >= 1
ebay_domain
enum<string>
默认值:ebay.com

eBay domain to search on

可用选项:
ebay.com,
ebay.com.au,
ebay.at,
befr.ebay.be,
benl.ebay.be,
ebay.ca,
cafr.ebay.ca,
ebay.fr,
ebay.de,
ebay.com.hk,
ebay.ie,
ebay.it,
ebay.com.my,
ebay.nl,
ebay.ph,
ebay.pl,
ebay.com.sg,
ebay.es,
ebay.ch,
ebay.co.uk
engine
enum<string>
必填

Search engine to use

可用选项:
ebay_search
filters
string

Comma-separated list of filters to apply

Pattern: ^(search_description|sale_items|deals_and_savings|free_shipping|local_pickup|fast_arrival|free_returns|returns_accepted|listed_as_lots|authenticity_guarantee|authorized_seller|benefits_charity|psa_vault)(,(search_description|sale_items|deals_and_savings|free_shipping|local_pickup|fast_arrival|free_returns|returns_accepted|listed_as_lots|authenticity_guarantee|authorized_seller|benefits_charity|psa_vault))*$

When set to true, returns eBay's "Results matching fewer words" items under a separate related_results key when no exact matches are found. Defaults to false, which returns an error in that case.

可用选项:
true,
false
layout
enum<string>

Results layout format

可用选项:
list,
grid
num
enum<integer>

Number of results per page

可用选项:
60,
120,
240
page
integer

Page number (starts at 1)

必填范围: x >= 1
postal_code
string

Postal code for distance-based searches. Only supported for certain delivery countries (US, CA, GB, AU, AT, BE, CZ, FR, DE, IT, NL, PL)

preferred_location
enum<string>

Preferred seller location

可用选项:
domestic,
regional,
worldwide
price_max
number

Maximum price filter (must be greater than or equal to price_min)

必填范围: x >= 0
price_min
number

Minimum price filter

必填范围: x >= 0
product_origin_country
enum<string>

Product origin country ISO 3166-1 alpha-2 code

可用选项:
US,
CA,
GB,
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BR,
VG,
BN,
BG,
BF,
BI,
KH,
CM,
CV,
KY,
CF,
TD,
CL,
CN,
CO,
KM,
CD,
CG,
CK,
CR,
CI,
HR,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FJ,
FI,
FR,
GF,
PF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KR,
KW,
KG,
LA,
LV,
LB,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NO,
OM,
PK,
PW,
PA,
PG,
PY,
PE,
PH,
PL,
PT,
PR,
QA,
RO,
RU,
RW,
SH,
KN,
LC,
PM,
VC,
SM,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
ES,
LK,
SR,
SZ,
SE,
CH,
TW,
TJ,
TZ,
TH,
TG,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
UY,
UZ,
VU,
VA,
VE,
VN,
VI,
WF,
EH,
WS,
YE,
FM,
RE,
ME,
RS
q
string

Search query. Either 'q' or 'category_id' must be present

sort_by
enum<string>

Sort results by

可用选项:
best_match,
price_shipping_low_to_high,
price_shipping_high_to_low,
distance_nearest,
time_ending_soonest,
time_newly_listed,
price_low_to_high,
price_high_to_low,
condition_new_first,
condition_used_first

响应

成功响应

search_metadata
object
search_parameters
object
search_information
object
categories
object[]
filters
object[]
organic_results
object[]

Returned in place of organic_results when eBay has no exact matches but shows "Results matching fewer words" items.

sections
object[]
pagination
object
error
string

Error message when no results are found