bidkit 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bidkit/__init__.py +49 -0
- bidkit/auth.py +477 -0
- bidkit/client.py +212 -0
- bidkit/config.py +216 -0
- bidkit/errors.py +68 -0
- bidkit/generated/__init__.py +1 -0
- bidkit/generated/models/__init__.py +1 -0
- bidkit/generated/models/buy_browse.py +3162 -0
- bidkit/generated/models/buy_deal.py +604 -0
- bidkit/generated/models/buy_feed.py +1377 -0
- bidkit/generated/models/buy_marketing.py +891 -0
- bidkit/generated/models/buy_marketplace_insights.py +432 -0
- bidkit/generated/models/buy_offer.py +310 -0
- bidkit/generated/models/buy_order.py +1363 -0
- bidkit/generated/models/cancellation.py +6 -0
- bidkit/generated/models/case.py +99 -0
- bidkit/generated/models/commerce_catalog.py +318 -0
- bidkit/generated/models/commerce_charity.py +412 -0
- bidkit/generated/models/commerce_feedback.py +756 -0
- bidkit/generated/models/commerce_identity.py +511 -0
- bidkit/generated/models/commerce_media.py +333 -0
- bidkit/generated/models/commerce_message.py +390 -0
- bidkit/generated/models/commerce_notification.py +399 -0
- bidkit/generated/models/commerce_taxonomy.py +511 -0
- bidkit/generated/models/commerce_translation.py +121 -0
- bidkit/generated/models/commerce_vero.py +560 -0
- bidkit/generated/models/developer_analytics.py +116 -0
- bidkit/generated/models/developer_client_registration.py +140 -0
- bidkit/generated/models/developer_key_management.py +111 -0
- bidkit/generated/models/inquiry.py +95 -0
- bidkit/generated/models/return_.py +69 -0
- bidkit/generated/models/sell_account_v1.py +1929 -0
- bidkit/generated/models/sell_account_v2.py +1020 -0
- bidkit/generated/models/sell_analytics.py +629 -0
- bidkit/generated/models/sell_compliance.py +235 -0
- bidkit/generated/models/sell_edelivery_international_shipping.py +1993 -0
- bidkit/generated/models/sell_feed.py +853 -0
- bidkit/generated/models/sell_finances.py +1348 -0
- bidkit/generated/models/sell_fulfillment.py +2645 -0
- bidkit/generated/models/sell_inventory.py +2949 -0
- bidkit/generated/models/sell_leads.py +234 -0
- bidkit/generated/models/sell_listing.py +169 -0
- bidkit/generated/models/sell_logistics.py +1027 -0
- bidkit/generated/models/sell_marketing.py +3656 -0
- bidkit/generated/models/sell_metadata.py +2552 -0
- bidkit/generated/models/sell_negotiation.py +414 -0
- bidkit/generated/models/sell_recommendation.py +149 -0
- bidkit/generated/models/sell_stores.py +214 -0
- bidkit/generated/resources.py +19909 -0
- bidkit/models.py +43 -0
- bidkit/notifications.py +196 -0
- bidkit/pagination.py +137 -0
- bidkit/py.typed +0 -0
- bidkit/resource.py +166 -0
- bidkit/retry.py +81 -0
- bidkit/signing.py +162 -0
- bidkit/transport.py +499 -0
- bidkit-0.1.0.dist-info/METADATA +425 -0
- bidkit-0.1.0.dist-info/RECORD +62 -0
- bidkit-0.1.0.dist-info/WHEEL +4 -0
- bidkit-0.1.0.dist-info/licenses/LICENSE +21 -0
- bidkit-0.1.0.dist-info/licenses/NOTICE +15 -0
|
@@ -0,0 +1,2552 @@
|
|
|
1
|
+
# ruff: noqa
|
|
2
|
+
# generated by datamodel-codegen:
|
|
3
|
+
# filename: sell_metadata_v1_oas3.json
|
|
4
|
+
|
|
5
|
+
from __future__ import annotations
|
|
6
|
+
|
|
7
|
+
from bidkit.models import OpenStrEnum
|
|
8
|
+
|
|
9
|
+
from bidkit.models import EbayModel
|
|
10
|
+
from pydantic import Field
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class AdFormatEnabledEnum(OpenStrEnum):
|
|
14
|
+
disabled = 'DISABLED'
|
|
15
|
+
enabled = 'ENABLED'
|
|
16
|
+
only = 'ONLY'
|
|
17
|
+
classified_ad_enabled = 'CLASSIFIED_AD_ENABLED'
|
|
18
|
+
classified_ad_only = 'CLASSIFIED_AD_ONLY'
|
|
19
|
+
local_market_best_offer_only = 'LOCAL_MARKET_BEST_OFFER_ONLY'
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class CardinalityEnum(OpenStrEnum):
|
|
23
|
+
single = 'SINGLE'
|
|
24
|
+
multi = 'MULTI'
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class ClassifiedAdBestOfferEnabledEnum(OpenStrEnum):
|
|
28
|
+
disabled = 'DISABLED'
|
|
29
|
+
enabled = 'ENABLED'
|
|
30
|
+
required = 'REQUIRED'
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class ClassifiedAdPaymentMethodEnabledEnum(OpenStrEnum):
|
|
34
|
+
enabled_with_checkout = 'ENABLED_WITH_CHECKOUT'
|
|
35
|
+
enabled_without_checkout = 'ENABLED_WITHOUT_CHECKOUT'
|
|
36
|
+
not_supported = 'NOT_SUPPORTED'
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
class ClassifiedAdPolicy(EbayModel):
|
|
40
|
+
ad_format_enabled: AdFormatEnabledEnum | None = Field(
|
|
41
|
+
None,
|
|
42
|
+
alias='adFormatEnabled',
|
|
43
|
+
description='This enumerated value indicates the type or status of available Classified Ad formats for this category.',
|
|
44
|
+
)
|
|
45
|
+
category_id: str | None = Field(
|
|
46
|
+
None,
|
|
47
|
+
alias='categoryId',
|
|
48
|
+
description='The unique identifier of the eBay leaf category for which metadata is being returned.',
|
|
49
|
+
)
|
|
50
|
+
category_tree_id: str | None = Field(
|
|
51
|
+
None,
|
|
52
|
+
alias='categoryTreeId',
|
|
53
|
+
description='The unique identifier of the category tree.',
|
|
54
|
+
)
|
|
55
|
+
classified_ad_auto_accept_enabled: bool | None = Field(
|
|
56
|
+
None,
|
|
57
|
+
alias='classifiedAdAutoAcceptEnabled',
|
|
58
|
+
description='Indicates whether the category supports the Best Offer Automatic Accept feature for Classified Ad listings.',
|
|
59
|
+
)
|
|
60
|
+
classified_ad_auto_decline_enabled: bool | None = Field(
|
|
61
|
+
None,
|
|
62
|
+
alias='classifiedAdAutoDeclineEnabled',
|
|
63
|
+
description='Indicates whether the category supports the Best Offer Automatic Reject feature for Classified Ad listings.',
|
|
64
|
+
)
|
|
65
|
+
classified_ad_best_offer_enabled: ClassifiedAdBestOfferEnabledEnum | None = Field(
|
|
66
|
+
None,
|
|
67
|
+
alias='classifiedAdBestOfferEnabled',
|
|
68
|
+
description='This enumerated value indicates if Best Offer is enabled, disabled, or required for Classified Ad listings in this category.',
|
|
69
|
+
)
|
|
70
|
+
classified_ad_company_name_enabled: bool | None = Field(
|
|
71
|
+
None,
|
|
72
|
+
alias='classifiedAdCompanyNameEnabled',
|
|
73
|
+
description="Indicates whether this category supports including a company name in the seller's contact information. This element is for For Sale By Owner listings.",
|
|
74
|
+
)
|
|
75
|
+
classified_ad_contact_by_address_enabled: bool | None = Field(
|
|
76
|
+
None,
|
|
77
|
+
alias='classifiedAdContactByAddressEnabled',
|
|
78
|
+
description="Indicates whether this category supports including an address in the seller's contact information. This element is for For Sale By Owner listings.",
|
|
79
|
+
)
|
|
80
|
+
classified_ad_contact_by_email_enabled: bool | None = Field(
|
|
81
|
+
None,
|
|
82
|
+
alias='classifiedAdContactByEmailEnabled',
|
|
83
|
+
description="Indicates whether most categories support including an email address in the seller's contact information.",
|
|
84
|
+
)
|
|
85
|
+
classified_ad_contact_by_phone_enabled: bool | None = Field(
|
|
86
|
+
None,
|
|
87
|
+
alias='classifiedAdContactByPhoneEnabled',
|
|
88
|
+
description="Indicates whether most categories support including a phone number in the seller's contact information.",
|
|
89
|
+
)
|
|
90
|
+
classified_ad_counter_offer_enabled: bool | None = Field(
|
|
91
|
+
None,
|
|
92
|
+
alias='classifiedAdCounterOfferEnabled',
|
|
93
|
+
description='Indicates whether counter offers are allowed on Best offers for the category.',
|
|
94
|
+
)
|
|
95
|
+
classified_ad_payment_method_enabled: (
|
|
96
|
+
ClassifiedAdPaymentMethodEnabledEnum | None
|
|
97
|
+
) = Field(
|
|
98
|
+
None,
|
|
99
|
+
alias='classifiedAdPaymentMethodEnabled',
|
|
100
|
+
description='This enumerated value indicates support for the payment method being displayed to the user for the category. Even if enabled, checkout may or may not be enabled.',
|
|
101
|
+
)
|
|
102
|
+
classified_ad_phone_count: int | None = Field(
|
|
103
|
+
None,
|
|
104
|
+
alias='classifiedAdPhoneCount',
|
|
105
|
+
description='Indicates how many contact phone numbers can be specified in contact information for the category. This element is for For Sale By Owner listings.',
|
|
106
|
+
)
|
|
107
|
+
classified_ad_shipping_method_enabled: bool | None = Field(
|
|
108
|
+
None,
|
|
109
|
+
alias='classifiedAdShippingMethodEnabled',
|
|
110
|
+
description='Indicates if shipping methods can be specified and displayed in the View Item page for the category.',
|
|
111
|
+
)
|
|
112
|
+
classified_ad_street_count: int | None = Field(
|
|
113
|
+
None,
|
|
114
|
+
alias='classifiedAdStreetCount',
|
|
115
|
+
description='Indicates how many street addresses can be specified in contact information for the category. This element is for For Sale By Owner listings.',
|
|
116
|
+
)
|
|
117
|
+
seller_contact_details_enabled: bool | None = Field(
|
|
118
|
+
None,
|
|
119
|
+
alias='sellerContactDetailsEnabled',
|
|
120
|
+
description='Indicates whether this category supports seller-level contact information for Classified Ad listings.',
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
class CompatibilityDetails(EbayModel):
|
|
125
|
+
property_name: str | None = Field(
|
|
126
|
+
None,
|
|
127
|
+
alias='propertyName',
|
|
128
|
+
description='The name of the property being described.',
|
|
129
|
+
)
|
|
130
|
+
property_value: str | None = Field(
|
|
131
|
+
None,
|
|
132
|
+
alias='propertyValue',
|
|
133
|
+
description='The value for the property specified in the propertyName field.',
|
|
134
|
+
)
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
class CompatibilityTypeEnum(OpenStrEnum):
|
|
138
|
+
specifications = 'SPECIFICATIONS'
|
|
139
|
+
assembly = 'ASSEMBLY'
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
class CompatibleVehicleTypeEnum(OpenStrEnum):
|
|
143
|
+
us_cars_and_trucks = 'US_CARS_AND_TRUCKS'
|
|
144
|
+
us_motorcycles = 'US_MOTORCYCLES'
|
|
145
|
+
de_cars_and_trucks = 'DE_CARS_AND_TRUCKS'
|
|
146
|
+
uk_cars_and_trucks = 'UK_CARS_AND_TRUCKS'
|
|
147
|
+
us_atv = 'US_ATV'
|
|
148
|
+
au_cars_and_trucks = 'AU_CARS_AND_TRUCKS'
|
|
149
|
+
us_boats = 'US_BOATS'
|
|
150
|
+
us_atv_utv = 'US_ATV_UTV'
|
|
151
|
+
us_snowmobiles = 'US_SNOWMOBILES'
|
|
152
|
+
us_powersports = 'US_POWERSPORTS'
|
|
153
|
+
us_scooters = 'US_SCOOTERS'
|
|
154
|
+
us_golf_carts = 'US_GOLF_CARTS'
|
|
155
|
+
us_watercrafts = 'US_WATERCRAFTS'
|
|
156
|
+
de_motorcycles = 'DE_MOTORCYCLES'
|
|
157
|
+
de_scooters = 'DE_SCOOTERS'
|
|
158
|
+
uk_motorcycles = 'UK_MOTORCYCLES'
|
|
159
|
+
uk_scooters = 'UK_SCOOTERS'
|
|
160
|
+
it_cars_and_trucks = 'IT_CARS_AND_TRUCKS'
|
|
161
|
+
fr_cars_and_trucks = 'FR_CARS_AND_TRUCKS'
|
|
162
|
+
es_cars_and_trucks = 'ES_CARS_AND_TRUCKS'
|
|
163
|
+
ca_cars_and_trucks = 'CA_CARS_AND_TRUCKS'
|
|
164
|
+
default_value = 'DEFAULT_VALUE'
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
class CountryCodeEnum(OpenStrEnum):
|
|
168
|
+
ad = 'AD'
|
|
169
|
+
ae = 'AE'
|
|
170
|
+
af = 'AF'
|
|
171
|
+
ag = 'AG'
|
|
172
|
+
ai = 'AI'
|
|
173
|
+
al = 'AL'
|
|
174
|
+
am = 'AM'
|
|
175
|
+
an = 'AN'
|
|
176
|
+
ao = 'AO'
|
|
177
|
+
aq = 'AQ'
|
|
178
|
+
ar = 'AR'
|
|
179
|
+
as_ = 'AS'
|
|
180
|
+
at = 'AT'
|
|
181
|
+
au = 'AU'
|
|
182
|
+
aw = 'AW'
|
|
183
|
+
ax = 'AX'
|
|
184
|
+
az = 'AZ'
|
|
185
|
+
ba = 'BA'
|
|
186
|
+
bb = 'BB'
|
|
187
|
+
bd = 'BD'
|
|
188
|
+
be = 'BE'
|
|
189
|
+
bf = 'BF'
|
|
190
|
+
bg = 'BG'
|
|
191
|
+
bh = 'BH'
|
|
192
|
+
bi = 'BI'
|
|
193
|
+
bj = 'BJ'
|
|
194
|
+
bl = 'BL'
|
|
195
|
+
bm = 'BM'
|
|
196
|
+
bn = 'BN'
|
|
197
|
+
bo = 'BO'
|
|
198
|
+
bq = 'BQ'
|
|
199
|
+
br = 'BR'
|
|
200
|
+
bs = 'BS'
|
|
201
|
+
bt = 'BT'
|
|
202
|
+
bv = 'BV'
|
|
203
|
+
bw = 'BW'
|
|
204
|
+
by = 'BY'
|
|
205
|
+
bz = 'BZ'
|
|
206
|
+
ca = 'CA'
|
|
207
|
+
cc = 'CC'
|
|
208
|
+
cd = 'CD'
|
|
209
|
+
cf = 'CF'
|
|
210
|
+
cg = 'CG'
|
|
211
|
+
ch = 'CH'
|
|
212
|
+
ci = 'CI'
|
|
213
|
+
ck = 'CK'
|
|
214
|
+
cl = 'CL'
|
|
215
|
+
cm = 'CM'
|
|
216
|
+
cn = 'CN'
|
|
217
|
+
co = 'CO'
|
|
218
|
+
cr = 'CR'
|
|
219
|
+
cu = 'CU'
|
|
220
|
+
cv = 'CV'
|
|
221
|
+
cw = 'CW'
|
|
222
|
+
cx = 'CX'
|
|
223
|
+
cy = 'CY'
|
|
224
|
+
cz = 'CZ'
|
|
225
|
+
de = 'DE'
|
|
226
|
+
dj = 'DJ'
|
|
227
|
+
dk = 'DK'
|
|
228
|
+
dm = 'DM'
|
|
229
|
+
do = 'DO'
|
|
230
|
+
dz = 'DZ'
|
|
231
|
+
ec = 'EC'
|
|
232
|
+
ee = 'EE'
|
|
233
|
+
eg = 'EG'
|
|
234
|
+
eh = 'EH'
|
|
235
|
+
er = 'ER'
|
|
236
|
+
es = 'ES'
|
|
237
|
+
et = 'ET'
|
|
238
|
+
fi = 'FI'
|
|
239
|
+
fj = 'FJ'
|
|
240
|
+
fk = 'FK'
|
|
241
|
+
fm = 'FM'
|
|
242
|
+
fo = 'FO'
|
|
243
|
+
fr = 'FR'
|
|
244
|
+
ga = 'GA'
|
|
245
|
+
gb = 'GB'
|
|
246
|
+
gd = 'GD'
|
|
247
|
+
ge = 'GE'
|
|
248
|
+
gf = 'GF'
|
|
249
|
+
gg = 'GG'
|
|
250
|
+
gh = 'GH'
|
|
251
|
+
gi = 'GI'
|
|
252
|
+
gl = 'GL'
|
|
253
|
+
gm = 'GM'
|
|
254
|
+
gn = 'GN'
|
|
255
|
+
gp = 'GP'
|
|
256
|
+
gq = 'GQ'
|
|
257
|
+
gr = 'GR'
|
|
258
|
+
gs = 'GS'
|
|
259
|
+
gt = 'GT'
|
|
260
|
+
gu = 'GU'
|
|
261
|
+
gw = 'GW'
|
|
262
|
+
gy = 'GY'
|
|
263
|
+
hk = 'HK'
|
|
264
|
+
hm = 'HM'
|
|
265
|
+
hn = 'HN'
|
|
266
|
+
hr = 'HR'
|
|
267
|
+
ht = 'HT'
|
|
268
|
+
hu = 'HU'
|
|
269
|
+
id = 'ID'
|
|
270
|
+
ie = 'IE'
|
|
271
|
+
il = 'IL'
|
|
272
|
+
im = 'IM'
|
|
273
|
+
in_ = 'IN'
|
|
274
|
+
io = 'IO'
|
|
275
|
+
iq = 'IQ'
|
|
276
|
+
ir = 'IR'
|
|
277
|
+
is_ = 'IS'
|
|
278
|
+
it = 'IT'
|
|
279
|
+
je = 'JE'
|
|
280
|
+
jm = 'JM'
|
|
281
|
+
jo = 'JO'
|
|
282
|
+
jp = 'JP'
|
|
283
|
+
ke = 'KE'
|
|
284
|
+
kg = 'KG'
|
|
285
|
+
kh = 'KH'
|
|
286
|
+
ki = 'KI'
|
|
287
|
+
km = 'KM'
|
|
288
|
+
kn = 'KN'
|
|
289
|
+
kp = 'KP'
|
|
290
|
+
kr = 'KR'
|
|
291
|
+
kw = 'KW'
|
|
292
|
+
ky = 'KY'
|
|
293
|
+
kz = 'KZ'
|
|
294
|
+
la = 'LA'
|
|
295
|
+
lb = 'LB'
|
|
296
|
+
lc = 'LC'
|
|
297
|
+
li = 'LI'
|
|
298
|
+
lk = 'LK'
|
|
299
|
+
lr = 'LR'
|
|
300
|
+
ls = 'LS'
|
|
301
|
+
lt = 'LT'
|
|
302
|
+
lu = 'LU'
|
|
303
|
+
lv = 'LV'
|
|
304
|
+
ly = 'LY'
|
|
305
|
+
ma = 'MA'
|
|
306
|
+
mc = 'MC'
|
|
307
|
+
md = 'MD'
|
|
308
|
+
me = 'ME'
|
|
309
|
+
mf = 'MF'
|
|
310
|
+
mg = 'MG'
|
|
311
|
+
mh = 'MH'
|
|
312
|
+
mk = 'MK'
|
|
313
|
+
ml = 'ML'
|
|
314
|
+
mm = 'MM'
|
|
315
|
+
mn = 'MN'
|
|
316
|
+
mo = 'MO'
|
|
317
|
+
mp = 'MP'
|
|
318
|
+
mq = 'MQ'
|
|
319
|
+
mr = 'MR'
|
|
320
|
+
ms = 'MS'
|
|
321
|
+
mt = 'MT'
|
|
322
|
+
mu = 'MU'
|
|
323
|
+
mv = 'MV'
|
|
324
|
+
mw = 'MW'
|
|
325
|
+
mx = 'MX'
|
|
326
|
+
my = 'MY'
|
|
327
|
+
mz = 'MZ'
|
|
328
|
+
na = 'NA'
|
|
329
|
+
nc = 'NC'
|
|
330
|
+
ne = 'NE'
|
|
331
|
+
nf = 'NF'
|
|
332
|
+
ng = 'NG'
|
|
333
|
+
ni = 'NI'
|
|
334
|
+
nl = 'NL'
|
|
335
|
+
no = 'NO'
|
|
336
|
+
np = 'NP'
|
|
337
|
+
nr = 'NR'
|
|
338
|
+
nu = 'NU'
|
|
339
|
+
nz = 'NZ'
|
|
340
|
+
om = 'OM'
|
|
341
|
+
pa = 'PA'
|
|
342
|
+
pe = 'PE'
|
|
343
|
+
pf = 'PF'
|
|
344
|
+
pg = 'PG'
|
|
345
|
+
ph = 'PH'
|
|
346
|
+
pk = 'PK'
|
|
347
|
+
pl = 'PL'
|
|
348
|
+
pm = 'PM'
|
|
349
|
+
pn = 'PN'
|
|
350
|
+
pr = 'PR'
|
|
351
|
+
ps = 'PS'
|
|
352
|
+
pt = 'PT'
|
|
353
|
+
pw = 'PW'
|
|
354
|
+
py = 'PY'
|
|
355
|
+
qa = 'QA'
|
|
356
|
+
re = 'RE'
|
|
357
|
+
ro = 'RO'
|
|
358
|
+
rs = 'RS'
|
|
359
|
+
ru = 'RU'
|
|
360
|
+
rw = 'RW'
|
|
361
|
+
sa = 'SA'
|
|
362
|
+
sb = 'SB'
|
|
363
|
+
sc = 'SC'
|
|
364
|
+
sd = 'SD'
|
|
365
|
+
se = 'SE'
|
|
366
|
+
sg = 'SG'
|
|
367
|
+
sh = 'SH'
|
|
368
|
+
si = 'SI'
|
|
369
|
+
sj = 'SJ'
|
|
370
|
+
sk = 'SK'
|
|
371
|
+
sl = 'SL'
|
|
372
|
+
sm = 'SM'
|
|
373
|
+
sn = 'SN'
|
|
374
|
+
so = 'SO'
|
|
375
|
+
sr = 'SR'
|
|
376
|
+
st = 'ST'
|
|
377
|
+
sv = 'SV'
|
|
378
|
+
sx = 'SX'
|
|
379
|
+
sy = 'SY'
|
|
380
|
+
sz = 'SZ'
|
|
381
|
+
tc = 'TC'
|
|
382
|
+
td = 'TD'
|
|
383
|
+
tf = 'TF'
|
|
384
|
+
tg = 'TG'
|
|
385
|
+
th = 'TH'
|
|
386
|
+
tj = 'TJ'
|
|
387
|
+
tk = 'TK'
|
|
388
|
+
tl = 'TL'
|
|
389
|
+
tm = 'TM'
|
|
390
|
+
tn = 'TN'
|
|
391
|
+
to = 'TO'
|
|
392
|
+
tr = 'TR'
|
|
393
|
+
tt = 'TT'
|
|
394
|
+
tv = 'TV'
|
|
395
|
+
tw = 'TW'
|
|
396
|
+
tz = 'TZ'
|
|
397
|
+
ua = 'UA'
|
|
398
|
+
ug = 'UG'
|
|
399
|
+
um = 'UM'
|
|
400
|
+
us = 'US'
|
|
401
|
+
uy = 'UY'
|
|
402
|
+
uz = 'UZ'
|
|
403
|
+
va = 'VA'
|
|
404
|
+
vc = 'VC'
|
|
405
|
+
ve = 'VE'
|
|
406
|
+
vg = 'VG'
|
|
407
|
+
vi = 'VI'
|
|
408
|
+
vn = 'VN'
|
|
409
|
+
vu = 'VU'
|
|
410
|
+
wf = 'WF'
|
|
411
|
+
ws = 'WS'
|
|
412
|
+
ye = 'YE'
|
|
413
|
+
yt = 'YT'
|
|
414
|
+
za = 'ZA'
|
|
415
|
+
zm = 'ZM'
|
|
416
|
+
zw = 'ZW'
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
class CurrencyCodeEnum(OpenStrEnum):
|
|
420
|
+
aed = 'AED'
|
|
421
|
+
afn = 'AFN'
|
|
422
|
+
all = 'ALL'
|
|
423
|
+
amd = 'AMD'
|
|
424
|
+
aoa = 'AOA'
|
|
425
|
+
ars = 'ARS'
|
|
426
|
+
awg = 'AWG'
|
|
427
|
+
azn = 'AZN'
|
|
428
|
+
bam = 'BAM'
|
|
429
|
+
bbd = 'BBD'
|
|
430
|
+
bdt = 'BDT'
|
|
431
|
+
bgn = 'BGN'
|
|
432
|
+
bhd = 'BHD'
|
|
433
|
+
bif = 'BIF'
|
|
434
|
+
bmd = 'BMD'
|
|
435
|
+
bnd = 'BND'
|
|
436
|
+
bob = 'BOB'
|
|
437
|
+
brl = 'BRL'
|
|
438
|
+
bsd = 'BSD'
|
|
439
|
+
btn = 'BTN'
|
|
440
|
+
bwp = 'BWP'
|
|
441
|
+
byr = 'BYR'
|
|
442
|
+
bzd = 'BZD'
|
|
443
|
+
cad = 'CAD'
|
|
444
|
+
cdf = 'CDF'
|
|
445
|
+
clp = 'CLP'
|
|
446
|
+
cny = 'CNY'
|
|
447
|
+
cop = 'COP'
|
|
448
|
+
crc = 'CRC'
|
|
449
|
+
cup = 'CUP'
|
|
450
|
+
cve = 'CVE'
|
|
451
|
+
czk = 'CZK'
|
|
452
|
+
djf = 'DJF'
|
|
453
|
+
dop = 'DOP'
|
|
454
|
+
dzd = 'DZD'
|
|
455
|
+
egp = 'EGP'
|
|
456
|
+
ern = 'ERN'
|
|
457
|
+
etb = 'ETB'
|
|
458
|
+
fjd = 'FJD'
|
|
459
|
+
fkp = 'FKP'
|
|
460
|
+
gel = 'GEL'
|
|
461
|
+
ghs = 'GHS'
|
|
462
|
+
gip = 'GIP'
|
|
463
|
+
dkk = 'DKK'
|
|
464
|
+
gmd = 'GMD'
|
|
465
|
+
gnf = 'GNF'
|
|
466
|
+
gtq = 'GTQ'
|
|
467
|
+
gyd = 'GYD'
|
|
468
|
+
hkd = 'HKD'
|
|
469
|
+
hnl = 'HNL'
|
|
470
|
+
hrk = 'HRK'
|
|
471
|
+
htg = 'HTG'
|
|
472
|
+
huf = 'HUF'
|
|
473
|
+
idr = 'IDR'
|
|
474
|
+
inr = 'INR'
|
|
475
|
+
iqd = 'IQD'
|
|
476
|
+
irr = 'IRR'
|
|
477
|
+
isk = 'ISK'
|
|
478
|
+
gbp = 'GBP'
|
|
479
|
+
jmd = 'JMD'
|
|
480
|
+
jod = 'JOD'
|
|
481
|
+
jpy = 'JPY'
|
|
482
|
+
kes = 'KES'
|
|
483
|
+
kgs = 'KGS'
|
|
484
|
+
khr = 'KHR'
|
|
485
|
+
kmf = 'KMF'
|
|
486
|
+
kpw = 'KPW'
|
|
487
|
+
krw = 'KRW'
|
|
488
|
+
kwd = 'KWD'
|
|
489
|
+
kyd = 'KYD'
|
|
490
|
+
kzt = 'KZT'
|
|
491
|
+
lak = 'LAK'
|
|
492
|
+
lbp = 'LBP'
|
|
493
|
+
chf = 'CHF'
|
|
494
|
+
lkr = 'LKR'
|
|
495
|
+
lrd = 'LRD'
|
|
496
|
+
lsl = 'LSL'
|
|
497
|
+
ltl = 'LTL'
|
|
498
|
+
lyd = 'LYD'
|
|
499
|
+
mad = 'MAD'
|
|
500
|
+
mdl = 'MDL'
|
|
501
|
+
mga = 'MGA'
|
|
502
|
+
mkd = 'MKD'
|
|
503
|
+
mmk = 'MMK'
|
|
504
|
+
mnt = 'MNT'
|
|
505
|
+
mop = 'MOP'
|
|
506
|
+
mro_1 = 'MRO'
|
|
507
|
+
xcd = 'XCD'
|
|
508
|
+
mur = 'MUR'
|
|
509
|
+
mvr = 'MVR'
|
|
510
|
+
mwk = 'MWK'
|
|
511
|
+
mxn = 'MXN'
|
|
512
|
+
myr = 'MYR'
|
|
513
|
+
mzn = 'MZN'
|
|
514
|
+
nad = 'NAD'
|
|
515
|
+
ngn = 'NGN'
|
|
516
|
+
nio = 'NIO'
|
|
517
|
+
npr = 'NPR'
|
|
518
|
+
omr = 'OMR'
|
|
519
|
+
pab = 'PAB'
|
|
520
|
+
pen = 'PEN'
|
|
521
|
+
xpf = 'XPF'
|
|
522
|
+
pgk = 'PGK'
|
|
523
|
+
php = 'PHP'
|
|
524
|
+
pkr = 'PKR'
|
|
525
|
+
pln = 'PLN'
|
|
526
|
+
ils = 'ILS'
|
|
527
|
+
pyg = 'PYG'
|
|
528
|
+
qar = 'QAR'
|
|
529
|
+
ron = 'RON'
|
|
530
|
+
rsd = 'RSD'
|
|
531
|
+
rub = 'RUB'
|
|
532
|
+
rwf = 'RWF'
|
|
533
|
+
sar = 'SAR'
|
|
534
|
+
sbd = 'SBD'
|
|
535
|
+
scr = 'SCR'
|
|
536
|
+
sdg = 'SDG'
|
|
537
|
+
sek = 'SEK'
|
|
538
|
+
sgd = 'SGD'
|
|
539
|
+
shp = 'SHP'
|
|
540
|
+
nok = 'NOK'
|
|
541
|
+
sll = 'SLL'
|
|
542
|
+
sos = 'SOS'
|
|
543
|
+
srd = 'SRD'
|
|
544
|
+
std = 'STD'
|
|
545
|
+
ang = 'ANG'
|
|
546
|
+
syp = 'SYP'
|
|
547
|
+
szl = 'SZL'
|
|
548
|
+
xaf = 'XAF'
|
|
549
|
+
xof = 'XOF'
|
|
550
|
+
thb = 'THB'
|
|
551
|
+
tjs = 'TJS'
|
|
552
|
+
nzd = 'NZD'
|
|
553
|
+
tmt = 'TMT'
|
|
554
|
+
tnd = 'TND'
|
|
555
|
+
top = 'TOP'
|
|
556
|
+
try_ = 'TRY'
|
|
557
|
+
ttd = 'TTD'
|
|
558
|
+
aud = 'AUD'
|
|
559
|
+
twd = 'TWD'
|
|
560
|
+
tzs = 'TZS'
|
|
561
|
+
uah = 'UAH'
|
|
562
|
+
ugx = 'UGX'
|
|
563
|
+
usd = 'USD'
|
|
564
|
+
uyu = 'UYU'
|
|
565
|
+
uzs = 'UZS'
|
|
566
|
+
vef = 'VEF'
|
|
567
|
+
vnd = 'VND'
|
|
568
|
+
vuv = 'VUV'
|
|
569
|
+
wst = 'WST'
|
|
570
|
+
yer = 'YER'
|
|
571
|
+
eur = 'EUR'
|
|
572
|
+
zar = 'ZAR'
|
|
573
|
+
zmw = 'ZMW'
|
|
574
|
+
zwl = 'ZWL'
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
class DescriptorUsageEnum(OpenStrEnum):
|
|
578
|
+
required = 'REQUIRED'
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
class DisabledProductFilter(EbayModel):
|
|
582
|
+
exclude_for_ebay_reviews: bool | None = Field(
|
|
583
|
+
None,
|
|
584
|
+
alias='excludeForEbayReviews',
|
|
585
|
+
description='Specifies whether to filter out products excluded for eBay reviews. If set to true , items excluded from eBay reviews are not returned.',
|
|
586
|
+
)
|
|
587
|
+
exclude_for_ebay_selling: bool | None = Field(
|
|
588
|
+
None,
|
|
589
|
+
alias='excludeForEbaySelling',
|
|
590
|
+
description='Specifies whether to filter out products excluded for eBay selling. If set to true , items excluded from eBay selling are not returned.',
|
|
591
|
+
)
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
class DistanceType(OpenStrEnum):
|
|
595
|
+
local_listing_distances_regular = 'LOCAL_LISTING_DISTANCES_REGULAR'
|
|
596
|
+
local_listing_distances_specialty = 'LOCAL_LISTING_DISTANCES_SPECIALTY'
|
|
597
|
+
local_listing_distances_non_subscription = (
|
|
598
|
+
'LOCAL_LISTING_DISTANCES_NON_SUBSCRIPTION'
|
|
599
|
+
)
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
class DurationEnum(OpenStrEnum):
|
|
603
|
+
gtc = 'GTC'
|
|
604
|
+
days_1 = 'DAYS_1'
|
|
605
|
+
days_3 = 'DAYS_3'
|
|
606
|
+
days_5 = 'DAYS_5'
|
|
607
|
+
days_7 = 'DAYS_7'
|
|
608
|
+
days_10 = 'DAYS_10'
|
|
609
|
+
days_30 = 'DAYS_30'
|
|
610
|
+
days_90 = 'DAYS_90'
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
class ErrorParameter(EbayModel):
|
|
614
|
+
name: str | None = Field(None, description='The object of the error.')
|
|
615
|
+
value: str | None = Field(None, description='The value of the object.')
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
class ErrorParameterV3(EbayModel):
|
|
619
|
+
name: str | None = Field(
|
|
620
|
+
None, description='Name of the entity that threw the error.'
|
|
621
|
+
)
|
|
622
|
+
value: str | None = Field(None, description='A description of the error.')
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
class ExtendedProducerResponsibilityEnum(OpenStrEnum):
|
|
626
|
+
eco_participation_fee = 'ECO_PARTICIPATION_FEE'
|
|
627
|
+
take_back_policy = 'TAKE_BACK_POLICY'
|
|
628
|
+
repair_score = 'REPAIR_SCORE'
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
class GenericUsageEnum(OpenStrEnum):
|
|
632
|
+
optional = 'OPTIONAL'
|
|
633
|
+
recommended = 'RECOMMENDED'
|
|
634
|
+
required = 'REQUIRED'
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
class GeographicExposureEnum(OpenStrEnum):
|
|
638
|
+
national = 'National'
|
|
639
|
+
local_only = 'LocalOnly'
|
|
640
|
+
local_optional = 'LocalOptional'
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
class HazardStatement(EbayModel):
|
|
644
|
+
statement_id: str | None = Field(
|
|
645
|
+
None,
|
|
646
|
+
alias='statementId',
|
|
647
|
+
description='The identifier of the statement. For sample values, see Hazard statement sample values .',
|
|
648
|
+
)
|
|
649
|
+
statement_description: str | None = Field(
|
|
650
|
+
None,
|
|
651
|
+
alias='statementDescription',
|
|
652
|
+
description='The description of the statement localized to the default language of the marketplace. For sample values, see Hazard statement sample values .',
|
|
653
|
+
)
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
class ItemConditionDescriptorValueConstraint(EbayModel):
|
|
657
|
+
applicable_to_condition_descriptor_id: str | None = Field(
|
|
658
|
+
None,
|
|
659
|
+
alias='applicableToConditionDescriptorId',
|
|
660
|
+
description='This string is returned if the corresponding condition descriptor value requires an associated condition descriptor that must also be specified in a listing. The condition descriptor ID for the associated condition descriptors is returned here.',
|
|
661
|
+
)
|
|
662
|
+
applicable_to_condition_descriptor_value_ids: list[str] | None = Field(
|
|
663
|
+
None,
|
|
664
|
+
alias='applicableToConditionDescriptorValueIds',
|
|
665
|
+
description='This array is returned if the corresponding condition descriptor value is required for one or more associated condition descriptor values that must also be specified in a listing. The condition descriptor values IDs for the associated condition descriptor values are returned here.',
|
|
666
|
+
)
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
class ListingStructurePolicy(EbayModel):
|
|
670
|
+
category_id: str | None = Field(
|
|
671
|
+
None,
|
|
672
|
+
alias='categoryId',
|
|
673
|
+
description='The category ID to which the listing-structure policy applies.',
|
|
674
|
+
)
|
|
675
|
+
category_tree_id: str | None = Field(
|
|
676
|
+
None,
|
|
677
|
+
alias='categoryTreeId',
|
|
678
|
+
description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.',
|
|
679
|
+
)
|
|
680
|
+
variations_supported: bool | None = Field(
|
|
681
|
+
None,
|
|
682
|
+
alias='variationsSupported',
|
|
683
|
+
description='This flag denotes whether or not the associated category supports listings with item variations. If set to true , the category does support item variations.',
|
|
684
|
+
)
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
class ListingTypeEnum(OpenStrEnum):
|
|
688
|
+
auction = 'AUCTION'
|
|
689
|
+
ad_type = 'AD_TYPE'
|
|
690
|
+
personal_offer = 'PERSONAL_OFFER'
|
|
691
|
+
fixed_price_item = 'FIXED_PRICE_ITEM'
|
|
692
|
+
lead_generation = 'LEAD_GENERATION'
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
class LocalListingDistance(EbayModel):
|
|
696
|
+
distances: list[int] | None = Field(
|
|
697
|
+
None,
|
|
698
|
+
description='This array indicates the radius (in miles) of the selling area for Local Market Vehicle listings.',
|
|
699
|
+
)
|
|
700
|
+
distance_type: DistanceType | None = Field(
|
|
701
|
+
None,
|
|
702
|
+
alias='distanceType',
|
|
703
|
+
description='This enumerated value indicates the type of local listing distances, such as non-subscription or regular, for items listed by sellers.',
|
|
704
|
+
)
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
class MarketplaceIdEnum(OpenStrEnum):
|
|
708
|
+
ebay_us = 'EBAY_US'
|
|
709
|
+
ebay_ca = 'EBAY_CA'
|
|
710
|
+
ebay_gb = 'EBAY_GB'
|
|
711
|
+
ebay_au = 'EBAY_AU'
|
|
712
|
+
ebay_at = 'EBAY_AT'
|
|
713
|
+
ebay_be = 'EBAY_BE'
|
|
714
|
+
ebay_de = 'EBAY_DE'
|
|
715
|
+
ebay_it = 'EBAY_IT'
|
|
716
|
+
ebay_nl = 'EBAY_NL'
|
|
717
|
+
ebay_es = 'EBAY_ES'
|
|
718
|
+
ebay_ch = 'EBAY_CH'
|
|
719
|
+
ebay_tw = 'EBAY_TW'
|
|
720
|
+
ebay_cz = 'EBAY_CZ'
|
|
721
|
+
ebay_dk = 'EBAY_DK'
|
|
722
|
+
ebay_fi = 'EBAY_FI'
|
|
723
|
+
ebay_fr = 'EBAY_FR'
|
|
724
|
+
ebay_gr = 'EBAY_GR'
|
|
725
|
+
ebay_hk = 'EBAY_HK'
|
|
726
|
+
ebay_hu = 'EBAY_HU'
|
|
727
|
+
ebay_in = 'EBAY_IN'
|
|
728
|
+
ebay_id = 'EBAY_ID'
|
|
729
|
+
ebay_ie = 'EBAY_IE'
|
|
730
|
+
ebay_il = 'EBAY_IL'
|
|
731
|
+
ebay_my = 'EBAY_MY'
|
|
732
|
+
ebay_nz = 'EBAY_NZ'
|
|
733
|
+
ebay_no = 'EBAY_NO'
|
|
734
|
+
ebay_ph = 'EBAY_PH'
|
|
735
|
+
ebay_pl = 'EBAY_PL'
|
|
736
|
+
ebay_pt = 'EBAY_PT'
|
|
737
|
+
ebay_pr = 'EBAY_PR'
|
|
738
|
+
ebay_ru = 'EBAY_RU'
|
|
739
|
+
ebay_sg = 'EBAY_SG'
|
|
740
|
+
ebay_za = 'EBAY_ZA'
|
|
741
|
+
ebay_se = 'EBAY_SE'
|
|
742
|
+
ebay_th = 'EBAY_TH'
|
|
743
|
+
ebay_vn = 'EBAY_VN'
|
|
744
|
+
ebay_cn = 'EBAY_CN'
|
|
745
|
+
ebay_jp = 'EBAY_JP'
|
|
746
|
+
ebay_pe = 'EBAY_PE'
|
|
747
|
+
ebay_half_us = 'EBAY_HALF_US'
|
|
748
|
+
ebay_motors_us = 'EBAY_MOTORS_US'
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
class ModeEnum(OpenStrEnum):
|
|
752
|
+
selection_only = 'SELECTION_ONLY'
|
|
753
|
+
free_text = 'FREE_TEXT'
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
class MotorsListingPolicy(EbayModel):
|
|
757
|
+
category_id: str | None = Field(
|
|
758
|
+
None,
|
|
759
|
+
alias='categoryId',
|
|
760
|
+
description='The unique identifier of the eBay leaf category for which metadata is being returned.',
|
|
761
|
+
)
|
|
762
|
+
category_tree_id: str | None = Field(
|
|
763
|
+
None,
|
|
764
|
+
alias='categoryTreeId',
|
|
765
|
+
description='The unique identifier of the category tree.',
|
|
766
|
+
)
|
|
767
|
+
deposit_supported: bool | None = Field(
|
|
768
|
+
None,
|
|
769
|
+
alias='depositSupported',
|
|
770
|
+
description='This field is returned as true if the corresponding category supports the use of a deposit/down payment on a motor vehicle listing. In an AddItem call, the seller can configure a down payment for a motor vehicle listing using the PaymentDetails container.',
|
|
771
|
+
)
|
|
772
|
+
ebay_motors_pro_ad_format_enabled: AdFormatEnabledEnum | None = Field(
|
|
773
|
+
None,
|
|
774
|
+
alias='ebayMotorsProAdFormatEnabled',
|
|
775
|
+
description='Indicates whether or not eBay Motors Pro sellers can use classified ads in this category to sell their vehicles. This element is applicable for eBay Motors Pro users.',
|
|
776
|
+
)
|
|
777
|
+
ebay_motors_pro_auto_accept_enabled: bool | None = Field(
|
|
778
|
+
None,
|
|
779
|
+
alias='ebayMotorsProAutoAcceptEnabled',
|
|
780
|
+
description='Indicates whether or not the category supports the Best Offer Auto Accept feature for eBay Motors Pro listings. This element is for eBay Motors Pro users.',
|
|
781
|
+
)
|
|
782
|
+
ebay_motors_pro_auto_decline_enabled: bool | None = Field(
|
|
783
|
+
None,
|
|
784
|
+
alias='ebayMotorsProAutoDeclineEnabled',
|
|
785
|
+
description='Indicates whether or not the category allows auto-decline for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users.',
|
|
786
|
+
)
|
|
787
|
+
ebay_motors_pro_best_offer_enabled: ClassifiedAdBestOfferEnabledEnum | None = Field(
|
|
788
|
+
None,
|
|
789
|
+
alias='ebayMotorsProBestOfferEnabled',
|
|
790
|
+
description='This enumerated value indicates whether or not Best Offer features are supported for eBay Motors Classified Ad listings in this category. This element is for eBay Motors Pro users.',
|
|
791
|
+
)
|
|
792
|
+
ebay_motors_pro_company_name_enabled: bool | None = Field(
|
|
793
|
+
None,
|
|
794
|
+
alias='ebayMotorsProCompanyNameEnabled',
|
|
795
|
+
description="Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users.",
|
|
796
|
+
)
|
|
797
|
+
ebay_motors_pro_contact_by_address_enabled: bool | None = Field(
|
|
798
|
+
None,
|
|
799
|
+
alias='ebayMotorsProContactByAddressEnabled',
|
|
800
|
+
description="Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users.",
|
|
801
|
+
)
|
|
802
|
+
ebay_motors_pro_contact_by_email_enabled: bool | None = Field(
|
|
803
|
+
None,
|
|
804
|
+
alias='ebayMotorsProContactByEmailEnabled',
|
|
805
|
+
description="Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users.",
|
|
806
|
+
)
|
|
807
|
+
ebay_motors_pro_contact_by_phone_enabled: bool | None = Field(
|
|
808
|
+
None,
|
|
809
|
+
alias='ebayMotorsProContactByPhoneEnabled',
|
|
810
|
+
description="Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users.",
|
|
811
|
+
)
|
|
812
|
+
ebay_motors_pro_counter_offer_enabled: bool | None = Field(
|
|
813
|
+
None,
|
|
814
|
+
alias='ebayMotorsProCounterOfferEnabled',
|
|
815
|
+
description='Indicates whether counter offers are allowed on Best Offers for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users.',
|
|
816
|
+
)
|
|
817
|
+
ebay_motors_pro_payment_method_check_out_enabled: (
|
|
818
|
+
ClassifiedAdPaymentMethodEnabledEnum | None
|
|
819
|
+
) = Field(
|
|
820
|
+
None,
|
|
821
|
+
alias='ebayMotorsProPaymentMethodCheckOutEnabled',
|
|
822
|
+
description='This enumerated value indicates whether this category supports that the payment method should be displayed to the user for this category in an eBay Motors Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for eBay Motors Pro users.',
|
|
823
|
+
)
|
|
824
|
+
ebay_motors_pro_phone_count: int | None = Field(
|
|
825
|
+
None,
|
|
826
|
+
alias='ebayMotorsProPhoneCount',
|
|
827
|
+
description='Indicates the number of phone numbers that can be included through contact information for this category. This element is for eBay Motors Pro users.',
|
|
828
|
+
)
|
|
829
|
+
ebay_motors_pro_seller_contact_details_enabled: bool | None = Field(
|
|
830
|
+
None,
|
|
831
|
+
alias='ebayMotorsProSellerContactDetailsEnabled',
|
|
832
|
+
description='Indicates whether this category allows seller-level contact information for eBay Motors Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users.',
|
|
833
|
+
)
|
|
834
|
+
ebay_motors_pro_shipping_method_enabled: bool | None = Field(
|
|
835
|
+
None,
|
|
836
|
+
alias='ebayMotorsProShippingMethodEnabled',
|
|
837
|
+
description='Indicates if shipping options should be displayed to the user for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users.',
|
|
838
|
+
)
|
|
839
|
+
ebay_motors_pro_street_count: int | None = Field(
|
|
840
|
+
None,
|
|
841
|
+
alias='ebayMotorsProStreetCount',
|
|
842
|
+
description='This field indicates the number of street addresses allowed in contact information for this category. This element is for eBay Motors Pro users.',
|
|
843
|
+
)
|
|
844
|
+
epid_supported: bool | None = Field(
|
|
845
|
+
None,
|
|
846
|
+
alias='epidSupported',
|
|
847
|
+
description='If returned as true , this indicates the category supports the use of an eBay Product ID (e.g. ePID) to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites.',
|
|
848
|
+
)
|
|
849
|
+
k_type_supported: bool | None = Field(
|
|
850
|
+
None,
|
|
851
|
+
alias='kTypeSupported',
|
|
852
|
+
description='This field indicates whether or not the category supports the use of a K type to identify the cars and trucks compatible with a motor vehicle part or accessory. Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K types. See Compatibility by K type for more information',
|
|
853
|
+
)
|
|
854
|
+
local_listing_distances: list[LocalListingDistance] | None = Field(
|
|
855
|
+
None,
|
|
856
|
+
alias='localListingDistances',
|
|
857
|
+
description="This array shows the supported distances (in miles) for different types of Local Market subscription types in this category. Motor vehicle listings will be shown to buyers located within these proximities of the vehicle's location.",
|
|
858
|
+
)
|
|
859
|
+
local_market_ad_format_enabled: AdFormatEnabledEnum | None = Field(
|
|
860
|
+
None,
|
|
861
|
+
alias='localMarketAdFormatEnabled',
|
|
862
|
+
description='Specifies whether this category supports Motor Local Market Classified Ad listings.',
|
|
863
|
+
)
|
|
864
|
+
local_market_auto_accept_enabled: bool | None = Field(
|
|
865
|
+
None,
|
|
866
|
+
alias='localMarketAutoAcceptEnabled',
|
|
867
|
+
description='Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads.',
|
|
868
|
+
)
|
|
869
|
+
local_market_auto_decline_enabled: bool | None = Field(
|
|
870
|
+
None,
|
|
871
|
+
alias='localMarketAutoDeclineEnabled',
|
|
872
|
+
description='Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads.',
|
|
873
|
+
)
|
|
874
|
+
local_market_best_offer_enabled: ClassifiedAdBestOfferEnabledEnum | None = Field(
|
|
875
|
+
None,
|
|
876
|
+
alias='localMarketBestOfferEnabled',
|
|
877
|
+
description='Indicates if Best Offer is enabled/required for Motors Local Market Classified Ad listings in this category.',
|
|
878
|
+
)
|
|
879
|
+
local_market_company_name_enabled: bool | None = Field(
|
|
880
|
+
None,
|
|
881
|
+
alias='localMarketCompanyNameEnabled',
|
|
882
|
+
description="Indicates whether the category supports the seller's company name being specified when using Motors Local Market classified ads.",
|
|
883
|
+
)
|
|
884
|
+
local_market_contact_by_address_enabled: bool | None = Field(
|
|
885
|
+
None,
|
|
886
|
+
alias='localMarketContactByAddressEnabled',
|
|
887
|
+
description="Indicates whether this category supports including the address in the seller's contact information.",
|
|
888
|
+
)
|
|
889
|
+
local_market_contact_by_email_enabled: bool | None = Field(
|
|
890
|
+
None,
|
|
891
|
+
alias='localMarketContactByEmailEnabled',
|
|
892
|
+
description="Indicates whether the category supports including an email address in the seller's contact information.",
|
|
893
|
+
)
|
|
894
|
+
local_market_contact_by_phone_enabled: bool | None = Field(
|
|
895
|
+
None,
|
|
896
|
+
alias='localMarketContactByPhoneEnabled',
|
|
897
|
+
description="Indicates whether this category supports including the telephone in the seller's contact information.",
|
|
898
|
+
)
|
|
899
|
+
local_market_counter_offer_enabled: bool | None = Field(
|
|
900
|
+
None,
|
|
901
|
+
alias='localMarketCounterOfferEnabled',
|
|
902
|
+
description='Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings.',
|
|
903
|
+
)
|
|
904
|
+
local_market_non_subscription: bool | None = Field(
|
|
905
|
+
None,
|
|
906
|
+
alias='localMarketNonSubscription',
|
|
907
|
+
description='Indicates whether the category supports a seller creating a Motors Local Market listing without a subscription. This feature is only available to licensed vehicle dealers.',
|
|
908
|
+
)
|
|
909
|
+
local_market_payment_method_check_out_enabled: (
|
|
910
|
+
ClassifiedAdPaymentMethodEnabledEnum | None
|
|
911
|
+
) = Field(
|
|
912
|
+
None,
|
|
913
|
+
alias='localMarketPaymentMethodCheckOutEnabled',
|
|
914
|
+
description='Indicates if the payment method should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled.',
|
|
915
|
+
)
|
|
916
|
+
local_market_phone_count: int | None = Field(
|
|
917
|
+
None,
|
|
918
|
+
alias='localMarketPhoneCount',
|
|
919
|
+
description='Indicates the number of phone numbers that can be included through contact information for this category.',
|
|
920
|
+
)
|
|
921
|
+
local_market_premium_subscription: bool | None = Field(
|
|
922
|
+
None,
|
|
923
|
+
alias='localMarketPremiumSubscription',
|
|
924
|
+
description='Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers.',
|
|
925
|
+
)
|
|
926
|
+
local_market_regular_subscription: bool | None = Field(
|
|
927
|
+
None,
|
|
928
|
+
alias='localMarketRegularSubscription',
|
|
929
|
+
description='Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers.',
|
|
930
|
+
)
|
|
931
|
+
local_market_seller_contact_details_enabled: bool | None = Field(
|
|
932
|
+
None,
|
|
933
|
+
alias='localMarketSellerContactDetailsEnabled',
|
|
934
|
+
description='Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings.',
|
|
935
|
+
)
|
|
936
|
+
local_market_shipping_method_enabled: bool | None = Field(
|
|
937
|
+
None,
|
|
938
|
+
alias='localMarketShippingMethodEnabled',
|
|
939
|
+
description='Indicates if shipping methods should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled.',
|
|
940
|
+
)
|
|
941
|
+
local_market_speciality_subscription: bool | None = Field(
|
|
942
|
+
None,
|
|
943
|
+
alias='localMarketSpecialitySubscription',
|
|
944
|
+
description='Indicates whether the category supports the Specialty level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers.',
|
|
945
|
+
)
|
|
946
|
+
local_market_street_count: int | None = Field(
|
|
947
|
+
None,
|
|
948
|
+
alias='localMarketStreetCount',
|
|
949
|
+
description="Indicates which address option is enabled for the seller's contact information.",
|
|
950
|
+
)
|
|
951
|
+
max_granular_fitment_count: int | None = Field(
|
|
952
|
+
None,
|
|
953
|
+
alias='maxGranularFitmentCount',
|
|
954
|
+
description='Indicates the maximum number of compatible applications allowed per item when adding or revising items with compatibilities provided at the most detailed granularity. For example, in Car and Truck Parts on the US site, the most granular application would include Year, Make, Model, Trim, and Engine.',
|
|
955
|
+
)
|
|
956
|
+
max_item_compatibility: int | None = Field(
|
|
957
|
+
None,
|
|
958
|
+
alias='maxItemCompatibility',
|
|
959
|
+
description='Indicates the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually only. See Specify parts compatibility manually and Managing product compatibility for more information.',
|
|
960
|
+
)
|
|
961
|
+
min_item_compatibility: int | None = Field(
|
|
962
|
+
None,
|
|
963
|
+
alias='minItemCompatibility',
|
|
964
|
+
description='Indicates the minimum number of required compatible applications for listing items. A value of 0 indicates it is not mandatory to specify parts compatibilities when listing.',
|
|
965
|
+
)
|
|
966
|
+
non_subscription: GeographicExposureEnum | None = Field(
|
|
967
|
+
None,
|
|
968
|
+
alias='nonSubscription',
|
|
969
|
+
description='The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription.',
|
|
970
|
+
)
|
|
971
|
+
premium_subscription: GeographicExposureEnum | None = Field(
|
|
972
|
+
None,
|
|
973
|
+
alias='premiumSubscription',
|
|
974
|
+
description='The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription.',
|
|
975
|
+
)
|
|
976
|
+
regular_subscription: GeographicExposureEnum | None = Field(
|
|
977
|
+
None,
|
|
978
|
+
alias='regularSubscription',
|
|
979
|
+
description='The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription.',
|
|
980
|
+
)
|
|
981
|
+
seller_provided_title_supported: bool | None = Field(
|
|
982
|
+
None,
|
|
983
|
+
alias='sellerProvidedTitleSupported',
|
|
984
|
+
description="This field is returned as true if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle.",
|
|
985
|
+
)
|
|
986
|
+
speciality_subscription: GeographicExposureEnum | None = Field(
|
|
987
|
+
None,
|
|
988
|
+
alias='specialitySubscription',
|
|
989
|
+
description='The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription.',
|
|
990
|
+
)
|
|
991
|
+
vin_supported: bool | None = Field(
|
|
992
|
+
None,
|
|
993
|
+
alias='vinSupported',
|
|
994
|
+
description='Indicates if Vehicle Identification Number is supported.',
|
|
995
|
+
)
|
|
996
|
+
vrm_supported: bool | None = Field(
|
|
997
|
+
None,
|
|
998
|
+
alias='vrmSupported',
|
|
999
|
+
description='Indicates if Vehicle Registration Mark is supported.',
|
|
1000
|
+
)
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
class NegotiatedPricePolicy(EbayModel):
|
|
1004
|
+
best_offer_auto_accept_enabled: bool | None = Field(
|
|
1005
|
+
None,
|
|
1006
|
+
alias='bestOfferAutoAcceptEnabled',
|
|
1007
|
+
description='This flag denotes whether or not the category supports the setting of a price at which best offers are automatically accepted. If set to true , the category does support the setting of an automatic price for best-offers.',
|
|
1008
|
+
)
|
|
1009
|
+
best_offer_auto_decline_enabled: bool | None = Field(
|
|
1010
|
+
None,
|
|
1011
|
+
alias='bestOfferAutoDeclineEnabled',
|
|
1012
|
+
description='This flag denotes whether or not the category supports the setting of an auto-decline price for best offers. If set to true , the category does support the setting of an automatic-decline price for best-offers.',
|
|
1013
|
+
)
|
|
1014
|
+
best_offer_counter_enabled: bool | None = Field(
|
|
1015
|
+
None,
|
|
1016
|
+
alias='bestOfferCounterEnabled',
|
|
1017
|
+
description='This flag denotes whether or not the category supports the setting for an automatic counter-offer on best offers. If set to true , the category does support the setting of an automatic counter-offer price for best-offers.',
|
|
1018
|
+
)
|
|
1019
|
+
category_id: str | None = Field(
|
|
1020
|
+
None,
|
|
1021
|
+
alias='categoryId',
|
|
1022
|
+
description='The category ID to which the negotiated-price policies apply.',
|
|
1023
|
+
)
|
|
1024
|
+
category_tree_id: str | None = Field(
|
|
1025
|
+
None,
|
|
1026
|
+
alias='categoryTreeId',
|
|
1027
|
+
description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.',
|
|
1028
|
+
)
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
class PackageLimits(EbayModel):
|
|
1032
|
+
dimension_unit: str | None = Field(
|
|
1033
|
+
None,
|
|
1034
|
+
alias='dimensionUnit',
|
|
1035
|
+
description='Unit of dimensional measurement, for example INCH or CENTIMETER .',
|
|
1036
|
+
)
|
|
1037
|
+
max_girth: float | None = Field(
|
|
1038
|
+
None,
|
|
1039
|
+
alias='maxGirth',
|
|
1040
|
+
description='The maximum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1041
|
+
)
|
|
1042
|
+
max_height: float | None = Field(
|
|
1043
|
+
None,
|
|
1044
|
+
alias='maxHeight',
|
|
1045
|
+
description='The maximum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1046
|
+
)
|
|
1047
|
+
max_length: float | None = Field(
|
|
1048
|
+
None,
|
|
1049
|
+
alias='maxLength',
|
|
1050
|
+
description='The maximum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1051
|
+
)
|
|
1052
|
+
max_weight: float | None = Field(
|
|
1053
|
+
None,
|
|
1054
|
+
alias='maxWeight',
|
|
1055
|
+
description='The maximum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit .',
|
|
1056
|
+
)
|
|
1057
|
+
max_width: float | None = Field(
|
|
1058
|
+
None,
|
|
1059
|
+
alias='maxWidth',
|
|
1060
|
+
description='The maximum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1061
|
+
)
|
|
1062
|
+
min_girth: float | None = Field(
|
|
1063
|
+
None,
|
|
1064
|
+
alias='minGirth',
|
|
1065
|
+
description='The minimum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1066
|
+
)
|
|
1067
|
+
min_height: float | None = Field(
|
|
1068
|
+
None,
|
|
1069
|
+
alias='minHeight',
|
|
1070
|
+
description='The minimum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1071
|
+
)
|
|
1072
|
+
min_length: float | None = Field(
|
|
1073
|
+
None,
|
|
1074
|
+
alias='minLength',
|
|
1075
|
+
description='The minimum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1076
|
+
)
|
|
1077
|
+
min_weight: float | None = Field(
|
|
1078
|
+
None,
|
|
1079
|
+
alias='minWeight',
|
|
1080
|
+
description='The minimum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit .',
|
|
1081
|
+
)
|
|
1082
|
+
min_width: float | None = Field(
|
|
1083
|
+
None,
|
|
1084
|
+
alias='minWidth',
|
|
1085
|
+
description='The minimum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .',
|
|
1086
|
+
)
|
|
1087
|
+
weight_unit: str | None = Field(
|
|
1088
|
+
None,
|
|
1089
|
+
alias='weightUnit',
|
|
1090
|
+
description='Unit of weight measurement, for example KILOGRAM or OUNCE .',
|
|
1091
|
+
)
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
class Pagination(EbayModel):
|
|
1095
|
+
count: int | None = Field(
|
|
1096
|
+
None,
|
|
1097
|
+
description='The number of results showing on the current page of results.',
|
|
1098
|
+
)
|
|
1099
|
+
limit: int | None = Field(
|
|
1100
|
+
None,
|
|
1101
|
+
description='The max number of entries that can be returned on a single page.',
|
|
1102
|
+
)
|
|
1103
|
+
offset: int | None = Field(
|
|
1104
|
+
None,
|
|
1105
|
+
description='The number of items that will be skipped in the result set before returning the first item in the paginated response.',
|
|
1106
|
+
)
|
|
1107
|
+
total: int | None = Field(
|
|
1108
|
+
None, description='The total number of results in a result set.'
|
|
1109
|
+
)
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
class PaginationInput(EbayModel):
|
|
1113
|
+
limit: int | None = Field(
|
|
1114
|
+
None,
|
|
1115
|
+
description='The max number of items, from the current result set, returned on a single page. Note: For getProductCompatibilities , the max value is 100. If no limit is specified, this field defaults to the max value.',
|
|
1116
|
+
)
|
|
1117
|
+
offset: int | None = Field(
|
|
1118
|
+
None,
|
|
1119
|
+
description='The number of items that will be skipped in the result set before returning the first item in the paginated response. Combine offset with limit to control the items returned in the response. For example, if you supply an offset of 10 and a limit of 20, the first page of the response contains items 11-30 from the complete result set. Default: 0',
|
|
1120
|
+
)
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
class PaymentEnum(OpenStrEnum):
|
|
1124
|
+
cash_on_pickup = 'CASH_ON_PICKUP'
|
|
1125
|
+
payment_see_description = 'PAYMENT_SEE_DESCRIPTION'
|
|
1126
|
+
mocc = 'MOCC'
|
|
1127
|
+
personal_check = 'PERSONAL_CHECK'
|
|
1128
|
+
other = 'OTHER'
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
class Pictogram(EbayModel):
|
|
1132
|
+
pictogram_id: str | None = Field(
|
|
1133
|
+
None,
|
|
1134
|
+
alias='pictogramId',
|
|
1135
|
+
description='The identifier of the pictogram. For sample values, see Pictogram sample values .',
|
|
1136
|
+
)
|
|
1137
|
+
pictogram_description: str | None = Field(
|
|
1138
|
+
None,
|
|
1139
|
+
alias='pictogramDescription',
|
|
1140
|
+
description='The description of the pictogram localized to the default language of the marketplace. For sample values, see Pictogram sample values .',
|
|
1141
|
+
)
|
|
1142
|
+
pictogram_url: str | None = Field(
|
|
1143
|
+
None, alias='pictogramUrl', description='The URL of the pictogram.'
|
|
1144
|
+
)
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
class ProductIdentiferEnabledEnum(OpenStrEnum):
|
|
1148
|
+
disabled = 'DISABLED'
|
|
1149
|
+
enabled = 'ENABLED'
|
|
1150
|
+
required = 'REQUIRED'
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
class ProductIdentifier(EbayModel):
|
|
1154
|
+
ean: str | None = Field(
|
|
1155
|
+
None,
|
|
1156
|
+
description='The EAN of the item, if applicable. EAN is the European Article Number, a barcode standard for retail product labeling primarily used outside of North America.',
|
|
1157
|
+
)
|
|
1158
|
+
epid: str | None = Field(
|
|
1159
|
+
None,
|
|
1160
|
+
description='The ePID (eBay Product Identifier) of the item, if applicable. ePID is a unique identifier used by eBay to track products in its catalog. Use the getProduct method of the Catalog API to retrieve the ePID of an item.',
|
|
1161
|
+
)
|
|
1162
|
+
isbn: str | None = Field(
|
|
1163
|
+
None,
|
|
1164
|
+
description='The ISBN of the item, if applicable. ISBN is the International Standard Book Number, a unique identifier for books.',
|
|
1165
|
+
)
|
|
1166
|
+
product_id: str | None = Field(
|
|
1167
|
+
None,
|
|
1168
|
+
alias='productId',
|
|
1169
|
+
description='The product ID of the item, if applicable. The product ID is a general term for a unique identifier assigned to a product.',
|
|
1170
|
+
)
|
|
1171
|
+
upc: str | None = Field(
|
|
1172
|
+
None,
|
|
1173
|
+
description='The UPC of the item, if applicable. UPC stands for Universal Product Code, a unique identifier for products, primarily in North America.',
|
|
1174
|
+
)
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
class ProductSafetyLabelPictogram(EbayModel):
|
|
1178
|
+
pictogram_description: str | None = Field(
|
|
1179
|
+
None,
|
|
1180
|
+
alias='pictogramDescription',
|
|
1181
|
+
description='The description of the pictogram localized to the default language of the marketplace.',
|
|
1182
|
+
)
|
|
1183
|
+
pictogram_id: str | None = Field(
|
|
1184
|
+
None, alias='pictogramId', description='The identifier of the pictogram.'
|
|
1185
|
+
)
|
|
1186
|
+
pictogram_url: str | None = Field(
|
|
1187
|
+
None, alias='pictogramUrl', description='The URL of the pictogram.'
|
|
1188
|
+
)
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
class ProductSafetyLabelStatement(EbayModel):
|
|
1192
|
+
statement_description: str | None = Field(
|
|
1193
|
+
None,
|
|
1194
|
+
alias='statementDescription',
|
|
1195
|
+
description='The description of the statement localized to the default language of the marketplace.',
|
|
1196
|
+
)
|
|
1197
|
+
statement_id: str | None = Field(
|
|
1198
|
+
None, alias='statementId', description='The identifier of the statement.'
|
|
1199
|
+
)
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
class ProductSafetyLabelsResponse(EbayModel):
|
|
1203
|
+
pictograms: list[ProductSafetyLabelPictogram] | None = Field(
|
|
1204
|
+
None,
|
|
1205
|
+
description='This array contains a list of pictograms of product safety labels for the specified marketplace.',
|
|
1206
|
+
)
|
|
1207
|
+
statements: list[ProductSafetyLabelStatement] | None = Field(
|
|
1208
|
+
None,
|
|
1209
|
+
description='This array contains available product safety labels statements for the specified marketplace.',
|
|
1210
|
+
)
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
class PropertyFilterInner(EbayModel):
|
|
1214
|
+
property_name: str | None = Field(
|
|
1215
|
+
None,
|
|
1216
|
+
alias='propertyName',
|
|
1217
|
+
description="The name of the property being described. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category.",
|
|
1218
|
+
)
|
|
1219
|
+
property_value: str | None = Field(
|
|
1220
|
+
None,
|
|
1221
|
+
alias='propertyValue',
|
|
1222
|
+
description='The value for the property specified in the properyName field. For example, if the propertyName is Make , then the propertyValue will be the specific make of the vehicle, such as Toyota . Use the getCompatibilityPropertyValues to retrieve valid property values associated with a specified property name.',
|
|
1223
|
+
)
|
|
1224
|
+
unit_of_measurement: str | None = Field(
|
|
1225
|
+
None,
|
|
1226
|
+
alias='unitOfMeasurement',
|
|
1227
|
+
description='The unit of measurement of the property being described, if applicable.',
|
|
1228
|
+
)
|
|
1229
|
+
url: str | None = Field(
|
|
1230
|
+
None,
|
|
1231
|
+
description='The URL associated with the property being described, if applicable.',
|
|
1232
|
+
)
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
class PropertyNamesRequest(EbayModel):
|
|
1236
|
+
category_id: str | None = Field(
|
|
1237
|
+
None,
|
|
1238
|
+
alias='categoryId',
|
|
1239
|
+
description='The unique identifier of the eBay leaf category for which to retrieve compatibility property names. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility.',
|
|
1240
|
+
)
|
|
1241
|
+
dataset: list[str] | None = Field(
|
|
1242
|
+
None,
|
|
1243
|
+
description='This array defines the properties that will be returned for the compatibility-enabled category. For example, if you specify Searchable , the compatibility details will contain properties that can be used to search for products, such as make or model. Valid values: DisplayableProductDetails : Properties for use in a user interface to describe products.',
|
|
1244
|
+
)
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
class PropertyNamesResponsePropertyNameMetadata(EbayModel):
|
|
1248
|
+
display_sequence: int | None = Field(
|
|
1249
|
+
None,
|
|
1250
|
+
alias='displaySequence',
|
|
1251
|
+
description='The numeric value indicating the ordering position of the property.',
|
|
1252
|
+
)
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
class PropertyNamesResponsePropertyNames(EbayModel):
|
|
1256
|
+
property_display_name: str | None = Field(
|
|
1257
|
+
None,
|
|
1258
|
+
alias='propertyDisplayName',
|
|
1259
|
+
description='The display name of a property. This is the localized name of the compatible property.',
|
|
1260
|
+
)
|
|
1261
|
+
property_name: str | None = Field(
|
|
1262
|
+
None,
|
|
1263
|
+
alias='propertyName',
|
|
1264
|
+
description='The canonical name of a property. This value is used as part of the name-value pairs used to specify compatibility.',
|
|
1265
|
+
)
|
|
1266
|
+
property_name_metadata: PropertyNamesResponsePropertyNameMetadata | None = Field(
|
|
1267
|
+
None, alias='propertyNameMetadata', description='The metadata for a property.'
|
|
1268
|
+
)
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
class PropertyValues(EbayModel):
|
|
1272
|
+
property_name: str | None = Field(
|
|
1273
|
+
None,
|
|
1274
|
+
alias='propertyName',
|
|
1275
|
+
description="The name of the property. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.",
|
|
1276
|
+
)
|
|
1277
|
+
property_value: str | None = Field(
|
|
1278
|
+
None,
|
|
1279
|
+
alias='propertyValue',
|
|
1280
|
+
description='The value for the property specified in the properyName field. For example, if the propertyName is make , then the propertyValue will be the specific make of the vehicle, such as Toyota .',
|
|
1281
|
+
)
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
class PropertyValuesRequest(EbayModel):
|
|
1285
|
+
category_id: str | None = Field(
|
|
1286
|
+
None,
|
|
1287
|
+
alias='categoryId',
|
|
1288
|
+
description='The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility.',
|
|
1289
|
+
)
|
|
1290
|
+
property_filters: list[PropertyFilterInner] | None = Field(
|
|
1291
|
+
None,
|
|
1292
|
+
alias='propertyFilters',
|
|
1293
|
+
description='This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to Make and the propertyValue is set to Honda , only compatible Honda vehicles will be returned.',
|
|
1294
|
+
)
|
|
1295
|
+
property_name: str | None = Field(
|
|
1296
|
+
None,
|
|
1297
|
+
alias='propertyName',
|
|
1298
|
+
description="This field specifies the name of the property for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category.",
|
|
1299
|
+
)
|
|
1300
|
+
sort_order: str | None = Field(
|
|
1301
|
+
None,
|
|
1302
|
+
alias='sortOrder',
|
|
1303
|
+
description='This field specifies the sort order for the property values in the result set. Valid values: Ascending Descending Note: If no search order is specified, values are sorted in ascending order.',
|
|
1304
|
+
)
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
class PropertyValuesResponse(EbayModel):
|
|
1308
|
+
metadata_version: str | None = Field(
|
|
1309
|
+
None,
|
|
1310
|
+
alias='metadataVersion',
|
|
1311
|
+
description='The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace.',
|
|
1312
|
+
)
|
|
1313
|
+
property_name: str | None = Field(
|
|
1314
|
+
None,
|
|
1315
|
+
alias='propertyName',
|
|
1316
|
+
description='The name of the property specified in the request.',
|
|
1317
|
+
)
|
|
1318
|
+
property_values: list[str] | None = Field(
|
|
1319
|
+
None,
|
|
1320
|
+
alias='propertyValues',
|
|
1321
|
+
description='This array specifies the property values associated with the specified propertyName , in the specified category.',
|
|
1322
|
+
)
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
class RefundMethodEnum(OpenStrEnum):
|
|
1326
|
+
money_back = 'MONEY_BACK'
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
class RegulatoryAttributeEnum(OpenStrEnum):
|
|
1330
|
+
hazmat = 'HAZMAT'
|
|
1331
|
+
energy_efficiency = 'ENERGY_EFFICIENCY'
|
|
1332
|
+
manufacturer_contact = 'MANUFACTURER_CONTACT'
|
|
1333
|
+
product_safety = 'PRODUCT_SAFETY'
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
class ReturnMethodEnum(OpenStrEnum):
|
|
1337
|
+
replacement = 'REPLACEMENT'
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
class ReturnShippingCostPayerEnum(OpenStrEnum):
|
|
1341
|
+
buyer = 'BUYER'
|
|
1342
|
+
seller = 'SELLER'
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
class SalesTaxJurisdiction(EbayModel):
|
|
1346
|
+
sales_tax_jurisdiction_id: str | None = Field(
|
|
1347
|
+
None,
|
|
1348
|
+
alias='salesTaxJurisdictionId',
|
|
1349
|
+
description='The unique ID for a sales-tax jurisdiction. Important! When countryCode is set to US , IDs for all 50 states, Washington, DC, and all US territories will be returned. However, the only salesTaxJurisdictionId values currently supported are: AS (American Samoa) GU (Guam MP Northern Mariana Islands PW (Palau) VI (US Virgin Islands)',
|
|
1350
|
+
)
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
class SalesTaxJurisdictions(EbayModel):
|
|
1354
|
+
sales_tax_jurisdictions: list[SalesTaxJurisdiction] | None = Field(
|
|
1355
|
+
None,
|
|
1356
|
+
alias='salesTaxJurisdictions',
|
|
1357
|
+
description='A list of sales-tax jurisdictions.',
|
|
1358
|
+
)
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
class ShippingCarrier(EbayModel):
|
|
1362
|
+
description: str | None = Field(
|
|
1363
|
+
None,
|
|
1364
|
+
description='The localized description of the shipping carrier, such as UPS , FedEx , and USPS .',
|
|
1365
|
+
)
|
|
1366
|
+
shipping_carrier: str | None = Field(
|
|
1367
|
+
None,
|
|
1368
|
+
alias='shippingCarrier',
|
|
1369
|
+
description='An enumerated value describing the shipping carrier returned, for example, UPS , FedEx , and USPS . These values are needed when providing shipment tracking information for each specific shipping carrier.',
|
|
1370
|
+
)
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
class ShippingCarrierResponse(EbayModel):
|
|
1374
|
+
shipping_carriers: list[ShippingCarrier] | None = Field(
|
|
1375
|
+
None,
|
|
1376
|
+
alias='shippingCarriers',
|
|
1377
|
+
description='A list of shipping carriers available for the marketplace.',
|
|
1378
|
+
)
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
class ShippingExcludeLocation(EbayModel):
|
|
1382
|
+
description: str | None = Field(None, description='The localized location name.')
|
|
1383
|
+
location: str | None = Field(
|
|
1384
|
+
None,
|
|
1385
|
+
description='The location or region to be excluded. Countries are returned through ISO 3166 codes . This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii).',
|
|
1386
|
+
)
|
|
1387
|
+
region: str | None = Field(
|
|
1388
|
+
None,
|
|
1389
|
+
description='The region of the excluded shipping area specified, such as: Africa Americas Asia Central America and Caribbean Europe Middle East North America Oceania South America Southeast Asia',
|
|
1390
|
+
)
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
class ShippingExcludeLocationResponse(EbayModel):
|
|
1394
|
+
exclude_shipping_locations: list[ShippingExcludeLocation] | None = Field(
|
|
1395
|
+
None,
|
|
1396
|
+
alias='excludeShippingLocations',
|
|
1397
|
+
description='The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that the seller has designated as excluded shipping locations.',
|
|
1398
|
+
)
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
class ShippingHandlingTime(EbayModel):
|
|
1402
|
+
description: str | None = Field(
|
|
1403
|
+
None, description='The localized description of the maximum handling time.'
|
|
1404
|
+
)
|
|
1405
|
+
extended_handling: bool | None = Field(
|
|
1406
|
+
None,
|
|
1407
|
+
alias='extendedHandling',
|
|
1408
|
+
description='This field is only returned if its value is true . If returned, it indicates that the corresponding handling time is considered extended handling for the marketplace. Extended handling times may be used for freight shipping, but should generally be avoided if possible, as they might adversely affect the buying decisions of potential customers.',
|
|
1409
|
+
)
|
|
1410
|
+
max_handling_time: int | None = Field(
|
|
1411
|
+
None,
|
|
1412
|
+
alias='maxHandlingTime',
|
|
1413
|
+
description="The integer value returned in this field indicates the maximum number of business days that the eBay site allows as a seller's handling time measured from when the buyer pays for the order. For example, if the maxHandlingTime value is set to 1 and a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday).",
|
|
1414
|
+
)
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
class ShippingHandlingTimeResponse(EbayModel):
|
|
1418
|
+
handling_times: list[ShippingHandlingTime] | None = Field(
|
|
1419
|
+
None,
|
|
1420
|
+
alias='handlingTimes',
|
|
1421
|
+
description='A list of supported handling times for the marketplace.',
|
|
1422
|
+
)
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
class ShippingLocation(EbayModel):
|
|
1426
|
+
description: str | None = Field(None, description='The localized location name.')
|
|
1427
|
+
shipping_location: str | None = Field(
|
|
1428
|
+
None,
|
|
1429
|
+
alias='shippingLocation',
|
|
1430
|
+
description='The name or abbreviation of the shipping location or region. Countries are returned through ISO 3166 codes . This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii).',
|
|
1431
|
+
)
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
class ShippingLocationResponse(EbayModel):
|
|
1435
|
+
shipping_locations: list[ShippingLocation] | None = Field(
|
|
1436
|
+
None,
|
|
1437
|
+
alias='shippingLocations',
|
|
1438
|
+
description='The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that can be set as shipping locations.',
|
|
1439
|
+
)
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
class ShippingService(EbayModel):
|
|
1443
|
+
description: str | None = Field(
|
|
1444
|
+
None,
|
|
1445
|
+
description='This field returns the localized name of the shipping service.',
|
|
1446
|
+
)
|
|
1447
|
+
international_service: bool | None = Field(
|
|
1448
|
+
None,
|
|
1449
|
+
alias='internationalService',
|
|
1450
|
+
description='A value of true indicates that the shipping service is international. An international shipping service option is required if an item is being shipped from one country (origin) to another (destination).',
|
|
1451
|
+
)
|
|
1452
|
+
max_shipping_time: int | None = Field(
|
|
1453
|
+
None,
|
|
1454
|
+
alias='maxShippingTime',
|
|
1455
|
+
description='This value indicates the maximum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService .',
|
|
1456
|
+
)
|
|
1457
|
+
min_shipping_time: int | None = Field(
|
|
1458
|
+
None,
|
|
1459
|
+
alias='minShippingTime',
|
|
1460
|
+
description='This value indicates the minimum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService .',
|
|
1461
|
+
)
|
|
1462
|
+
package_limits: PackageLimits | None = Field(
|
|
1463
|
+
None,
|
|
1464
|
+
alias='packageLimits',
|
|
1465
|
+
description='This container provides name-value pairs that specify physical constraints and measurement units of packages for the shippingCarrier and the corresponding shippingService . An empty container is returned if the shipping service does not have any package limits defined.',
|
|
1466
|
+
)
|
|
1467
|
+
shipping_carrier: str | None = Field(
|
|
1468
|
+
None,
|
|
1469
|
+
alias='shippingCarrier',
|
|
1470
|
+
description='The code for the shipping carrier returned, for example, UPS , FedEx , and USPS .',
|
|
1471
|
+
)
|
|
1472
|
+
shipping_category: str | None = Field(
|
|
1473
|
+
None,
|
|
1474
|
+
alias='shippingCategory',
|
|
1475
|
+
description='The shipping category of the shipping service including: ECONOMY , STANDARD , EXPEDITED , ONE_DAY , PICKUP , and other similar categories.',
|
|
1476
|
+
)
|
|
1477
|
+
shipping_cost_types: list[str] | None = Field(
|
|
1478
|
+
None,
|
|
1479
|
+
alias='shippingCostTypes',
|
|
1480
|
+
description='A list of shipping cost types that this shipping service option supports. For example, FLAT_RATE , CALCULATED , and FREIGHT .',
|
|
1481
|
+
)
|
|
1482
|
+
shipping_service: str | None = Field(
|
|
1483
|
+
None,
|
|
1484
|
+
alias='shippingService',
|
|
1485
|
+
description='The name of the shipping service. The shipping service named here can only be used in listings or in business policies if validForSellingFlow is true . The value returned in this field is used in listing APIs and business policies to set the shipping service.',
|
|
1486
|
+
)
|
|
1487
|
+
valid_for_selling_flow: bool | None = Field(
|
|
1488
|
+
None,
|
|
1489
|
+
alias='validForSellingFlow',
|
|
1490
|
+
description='A value of true indicates that the shippingService can be set as an available shipping service in the listing or through the fulfillment business policy.',
|
|
1491
|
+
)
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
class ShippingServiceResponse(EbayModel):
|
|
1495
|
+
shipping_services: list[ShippingService] | None = Field(
|
|
1496
|
+
None,
|
|
1497
|
+
alias='shippingServices',
|
|
1498
|
+
description='A complete list of shipping service options that can be used on the marketplace for shipping items.',
|
|
1499
|
+
)
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
class SignalWord(EbayModel):
|
|
1503
|
+
signal_word_id: str | None = Field(
|
|
1504
|
+
None,
|
|
1505
|
+
alias='signalWordId',
|
|
1506
|
+
description='The identifier of the signal word. For more information, see Signal word information .',
|
|
1507
|
+
)
|
|
1508
|
+
signal_word_description: str | None = Field(
|
|
1509
|
+
None,
|
|
1510
|
+
alias='signalWordDescription',
|
|
1511
|
+
description='The description of the signal word localized to the default language of the marketplace. For more information, see Signal word information .',
|
|
1512
|
+
)
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
class SiteVisibilityPolicy(EbayModel):
|
|
1516
|
+
category_id: str | None = Field(
|
|
1517
|
+
None,
|
|
1518
|
+
alias='categoryId',
|
|
1519
|
+
description='The unique identifier of the eBay leaf category for which metadata is being returned.',
|
|
1520
|
+
)
|
|
1521
|
+
category_tree_id: str | None = Field(
|
|
1522
|
+
None,
|
|
1523
|
+
alias='categoryTreeId',
|
|
1524
|
+
description='The unique identifier of the category tree.',
|
|
1525
|
+
)
|
|
1526
|
+
cross_border_trade_australia_enabled: bool | None = Field(
|
|
1527
|
+
None,
|
|
1528
|
+
alias='crossBorderTradeAustraliaEnabled',
|
|
1529
|
+
description='If true , the category supports specifying that listings of a seller on the UK marketplace can pass in Australia as a value in a field to expose that item on the eBay Australia site (ebay.com.au). For more information, see Cross-border trading .',
|
|
1530
|
+
)
|
|
1531
|
+
cross_border_trade_gb_enabled: bool | None = Field(
|
|
1532
|
+
None,
|
|
1533
|
+
alias='crossBorderTradeGBEnabled',
|
|
1534
|
+
description='If true , the category supports specifying that listings of a seller on the US or Canada marketplaces can pass in UK as a value in a field to expose that item on the eBay UK (ebay.co.uk) and eBay IE (ebay.ie) sites. For more information, see Cross-border trading .',
|
|
1535
|
+
)
|
|
1536
|
+
cross_border_trade_north_america_enabled: bool | None = Field(
|
|
1537
|
+
None,
|
|
1538
|
+
alias='crossBorderTradeNorthAmericaEnabled',
|
|
1539
|
+
description='If true , the category supports specifying that listings of a seller on the US or Canada marketplaces can pass in North America as a value in a field to expose that item on the eBay US (ebay.com) and eBay Canada (ebay.ca) sites (English). For more information, see Cross-border trading .',
|
|
1540
|
+
)
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
class SortOrderProperties(EbayModel):
|
|
1544
|
+
order: str | None = Field(
|
|
1545
|
+
None,
|
|
1546
|
+
description='Defines the order of the sort. Valid values : Ascending Descending',
|
|
1547
|
+
)
|
|
1548
|
+
property_name: str | None = Field(
|
|
1549
|
+
None,
|
|
1550
|
+
alias='propertyName',
|
|
1551
|
+
description="The name of the searchable property to be used for sorting. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.",
|
|
1552
|
+
)
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
class TimeDurationUnitEnum(OpenStrEnum):
|
|
1556
|
+
year = 'YEAR'
|
|
1557
|
+
month = 'MONTH'
|
|
1558
|
+
day = 'DAY'
|
|
1559
|
+
hour = 'HOUR'
|
|
1560
|
+
calendar_day = 'CALENDAR_DAY'
|
|
1561
|
+
business_day = 'BUSINESS_DAY'
|
|
1562
|
+
minute = 'MINUTE'
|
|
1563
|
+
second = 'SECOND'
|
|
1564
|
+
millisecond = 'MILLISECOND'
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
class UsageEnum(OpenStrEnum):
|
|
1568
|
+
restricted = 'RESTRICTED'
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
class Amount(EbayModel):
|
|
1572
|
+
currency: CurrencyCodeEnum | None = Field(
|
|
1573
|
+
None,
|
|
1574
|
+
description='The three-letter ISO 4217 code representing the currency of the amount in the value field. Restriction: Only the currency of the marketplace is supported. For example, on the US marketplace the only currency supported is USD.',
|
|
1575
|
+
)
|
|
1576
|
+
value: str | None = Field(
|
|
1577
|
+
None,
|
|
1578
|
+
description='The monetary amount, in the currency specified by the currency field.',
|
|
1579
|
+
)
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
class AutomotivePartsCompatibilityPolicy(EbayModel):
|
|
1583
|
+
category_id: str | None = Field(
|
|
1584
|
+
None,
|
|
1585
|
+
alias='categoryId',
|
|
1586
|
+
description='The category ID to which the automotive parts compatibility policies apply.',
|
|
1587
|
+
)
|
|
1588
|
+
category_tree_id: str | None = Field(
|
|
1589
|
+
None,
|
|
1590
|
+
alias='categoryTreeId',
|
|
1591
|
+
description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.',
|
|
1592
|
+
)
|
|
1593
|
+
compatibility_based_on: CompatibilityTypeEnum | None = Field(
|
|
1594
|
+
None,
|
|
1595
|
+
alias='compatibilityBasedOn',
|
|
1596
|
+
description='Indicates whether the category supports parts compatibility by either ASSEMBLY or by SPECIFICATION . Note: Only categories returning the compatibilityBasedOn field support compatibility. Categories where all compatibility fields are missing, or where only compatibilityBasedOn is missing, should be considered as not supporting compatibility.',
|
|
1597
|
+
)
|
|
1598
|
+
compatible_vehicle_types: list[CompatibleVehicleTypeEnum] | None = Field(
|
|
1599
|
+
None,
|
|
1600
|
+
alias='compatibleVehicleTypes',
|
|
1601
|
+
description='Indicates the compatibility classification of the part based on high-level vehicle types.',
|
|
1602
|
+
)
|
|
1603
|
+
max_number_of_compatible_vehicles: int | None = Field(
|
|
1604
|
+
None,
|
|
1605
|
+
alias='maxNumberOfCompatibleVehicles',
|
|
1606
|
+
description='Specifies the maximum number of compatible vehicle-applications allowed per item.',
|
|
1607
|
+
)
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
class CategoryPolicy(EbayModel):
|
|
1611
|
+
auto_pay_enabled: bool | None = Field(
|
|
1612
|
+
None,
|
|
1613
|
+
alias='autoPayEnabled',
|
|
1614
|
+
description="If this field is returned as true , the corresponding category supports immediate payment for listings. The immediate payment feature is applicable to fixed-price listings, to auction listings with the 'Buy It Now' option enabled, and for a motor vehicle listing that requires an initial deposit.",
|
|
1615
|
+
)
|
|
1616
|
+
b2b_vat_enabled: bool | None = Field(
|
|
1617
|
+
None,
|
|
1618
|
+
alias='b2bVatEnabled',
|
|
1619
|
+
description='If this field is returned as true , the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not have B2B VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only. This field is only returned when true (not returned when false).',
|
|
1620
|
+
)
|
|
1621
|
+
category_id: str | None = Field(
|
|
1622
|
+
None,
|
|
1623
|
+
alias='categoryId',
|
|
1624
|
+
description='The unique identifier of the eBay leaf category for which metadata is being returned.',
|
|
1625
|
+
)
|
|
1626
|
+
category_tree_id: str | None = Field(
|
|
1627
|
+
None,
|
|
1628
|
+
alias='categoryTreeId',
|
|
1629
|
+
description='The unique identifier of the category tree.',
|
|
1630
|
+
)
|
|
1631
|
+
ean_support: ProductIdentiferEnabledEnum | None = Field(
|
|
1632
|
+
None,
|
|
1633
|
+
alias='eanSupport',
|
|
1634
|
+
description='This enumerated value indicates whether or not European Article Numbers (EANs) are supported/required when listing products in the category.',
|
|
1635
|
+
)
|
|
1636
|
+
expired: bool | None = Field(
|
|
1637
|
+
None,
|
|
1638
|
+
description='If this field is returned as true , the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. You can use the getExpiredCategories method (of the Taxonomy API ) to find the leaf category that replaced the expired category. This field is only returned when true (not returned when false).',
|
|
1639
|
+
)
|
|
1640
|
+
intangible_enabled: bool | None = Field(
|
|
1641
|
+
None,
|
|
1642
|
+
alias='intangibleEnabled',
|
|
1643
|
+
description='If this field is returned as true , the category supports the listing of intangible goods or services.',
|
|
1644
|
+
)
|
|
1645
|
+
isbn_support: ProductIdentiferEnabledEnum | None = Field(
|
|
1646
|
+
None,
|
|
1647
|
+
alias='isbnSupport',
|
|
1648
|
+
description='This enumerated value indicates whether or not International Standard Book Numbers (ISBNs) are supported/required when listing products in the specified category.',
|
|
1649
|
+
)
|
|
1650
|
+
lsd: bool | None = Field(
|
|
1651
|
+
None,
|
|
1652
|
+
description='If this field (Lot Size Disabled) is returned as true , the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. This field is only returned when true (not returned when false).',
|
|
1653
|
+
)
|
|
1654
|
+
minimum_reserve_price: float | None = Field(
|
|
1655
|
+
None,
|
|
1656
|
+
alias='minimumReservePrice',
|
|
1657
|
+
description='Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of 0.0 is returned in this field.',
|
|
1658
|
+
)
|
|
1659
|
+
orpa: bool | None = Field(
|
|
1660
|
+
None,
|
|
1661
|
+
description="This field (Override Reserve Price Allowed) is returned as true if the eBay marketplace's default policy is to allow reserve prices for auction listings, but the corresponding category does not allow a reserve price. Note: This field is not returned if the marketplace does not permit reserve prices.",
|
|
1662
|
+
)
|
|
1663
|
+
orra: bool | None = Field(
|
|
1664
|
+
None,
|
|
1665
|
+
description='If this field (Override Reduce Reserve Allowed) is returned as true , the seller can reduce or remove a reserve price that had already been reduced for an active auction listing.',
|
|
1666
|
+
)
|
|
1667
|
+
payment_methods: list[PaymentEnum] | None = Field(
|
|
1668
|
+
None,
|
|
1669
|
+
alias='paymentMethods',
|
|
1670
|
+
description='An array that indicates the acceptable offline payment methods that can be used when listing an item for sale in the corresponding category.',
|
|
1671
|
+
)
|
|
1672
|
+
reduce_reserve_allowed: bool | None = Field(
|
|
1673
|
+
None,
|
|
1674
|
+
alias='reduceReserveAllowed',
|
|
1675
|
+
description="If this field (Reduce Reserve Allowed) is true , the corresponding leaf category allows the seller to reduce an item's reserve price. If false, this field is not returned in the response and the corresponding leaf category on the site do not normally allow sellers to reduce an item's reserve price. This field is only returned when true (not returned when false).",
|
|
1676
|
+
)
|
|
1677
|
+
reserve_price_allowed: bool | None = Field(
|
|
1678
|
+
None,
|
|
1679
|
+
alias='reservePriceAllowed',
|
|
1680
|
+
description='This field indicates whether reserve prices are allowed for auction listings in this category. This field returns as true when the category supports reserve prices, or false if the eBay marketplace does not permit reserve prices or the category override blocks reserve prices ( orpa is true ).',
|
|
1681
|
+
)
|
|
1682
|
+
upc_support: ProductIdentiferEnabledEnum | None = Field(
|
|
1683
|
+
None,
|
|
1684
|
+
alias='upcSupport',
|
|
1685
|
+
description='This enumerated value indicates whether or not the category on the specified eBay site supports the use of Universal Product Codes (UPCs) to help create a listing.',
|
|
1686
|
+
)
|
|
1687
|
+
value_category: bool | None = Field(
|
|
1688
|
+
None,
|
|
1689
|
+
alias='valueCategory',
|
|
1690
|
+
description='When returned as true , this boolean indicates that the leaf category for the specified site is designated by eBay as a value category. Value categories can be used as a secondary category for a listing at no extra charge.',
|
|
1691
|
+
)
|
|
1692
|
+
virtual: bool | None = Field(
|
|
1693
|
+
None,
|
|
1694
|
+
description='If this field is returned as true , the corresponding category is an eBay virtual category, a category in which items may not be listed. This field is only returned when true (not returned when false).',
|
|
1695
|
+
)
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
class Compatibility(EbayModel):
|
|
1699
|
+
compatibility_details: list[CompatibilityDetails] | None = Field(
|
|
1700
|
+
None,
|
|
1701
|
+
alias='compatibilityDetails',
|
|
1702
|
+
description='This array returns a list of compatibility details associated with the specified property name(s).',
|
|
1703
|
+
)
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
class Currency(EbayModel):
|
|
1707
|
+
code: CurrencyCodeEnum | None = Field(
|
|
1708
|
+
None,
|
|
1709
|
+
description='The three-letter ISO 4217 code returned. Restriction: Only the currency of the marketplace is supported. Examples: on the US marketplace, the only currency supported is the United States dollar, USD ; on the Canadian marketplace, the only currency supported is the Canadian dollar, CAD .',
|
|
1710
|
+
)
|
|
1711
|
+
description: str | None = Field(
|
|
1712
|
+
None,
|
|
1713
|
+
description='The description of the returned three-letter code. For example, if the code is USD , the description returned would be US Dollar .',
|
|
1714
|
+
)
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
class Error(EbayModel):
|
|
1718
|
+
category: str | None = Field(None, description='Identifies the type of error.')
|
|
1719
|
+
domain: str | None = Field(
|
|
1720
|
+
None,
|
|
1721
|
+
description='Name for the primary system where the error occurred. This is relevant for application errors.',
|
|
1722
|
+
)
|
|
1723
|
+
error_id: int | None = Field(
|
|
1724
|
+
None, alias='errorId', description='A unique number to identify the error.'
|
|
1725
|
+
)
|
|
1726
|
+
input_ref_ids: list[str] | None = Field(
|
|
1727
|
+
None,
|
|
1728
|
+
alias='inputRefIds',
|
|
1729
|
+
description='An array of request elements most closely associated to the error.',
|
|
1730
|
+
)
|
|
1731
|
+
long_message: str | None = Field(
|
|
1732
|
+
None,
|
|
1733
|
+
alias='longMessage',
|
|
1734
|
+
description='A more detailed explanation of the error.',
|
|
1735
|
+
)
|
|
1736
|
+
message: str | None = Field(
|
|
1737
|
+
None,
|
|
1738
|
+
description="Information on how to correct the problem, in the end user's terms and language where applicable.",
|
|
1739
|
+
)
|
|
1740
|
+
output_ref_ids: list[str] | None = Field(
|
|
1741
|
+
None,
|
|
1742
|
+
alias='outputRefIds',
|
|
1743
|
+
description='An array of request elements most closely associated to the error.',
|
|
1744
|
+
)
|
|
1745
|
+
parameters: list[ErrorParameter] | None = Field(
|
|
1746
|
+
None,
|
|
1747
|
+
description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.',
|
|
1748
|
+
)
|
|
1749
|
+
subdomain: str | None = Field(
|
|
1750
|
+
None,
|
|
1751
|
+
description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.',
|
|
1752
|
+
)
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
class ErrorDetailV3(EbayModel):
|
|
1756
|
+
category: str | None = Field(
|
|
1757
|
+
None,
|
|
1758
|
+
description="The category type for this error or warning. It takes an ErrorCategory object which can have one of three values: Application : Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.",
|
|
1759
|
+
)
|
|
1760
|
+
domain: str | None = Field(
|
|
1761
|
+
None, description='Name of the domain containing the service or application.'
|
|
1762
|
+
)
|
|
1763
|
+
error_id: int | None = Field(
|
|
1764
|
+
None,
|
|
1765
|
+
alias='errorId',
|
|
1766
|
+
description='A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.',
|
|
1767
|
+
)
|
|
1768
|
+
input_ref_ids: list[str] | None = Field(
|
|
1769
|
+
None,
|
|
1770
|
+
alias='inputRefIds',
|
|
1771
|
+
description="Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.",
|
|
1772
|
+
)
|
|
1773
|
+
long_message: str | None = Field(
|
|
1774
|
+
None,
|
|
1775
|
+
alias='longMessage',
|
|
1776
|
+
description='An expanded version of message that should be around 100-200 characters long, but is not required to be such.',
|
|
1777
|
+
)
|
|
1778
|
+
message: str | None = Field(
|
|
1779
|
+
None,
|
|
1780
|
+
description="An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.",
|
|
1781
|
+
)
|
|
1782
|
+
output_ref_ids: list[str] | None = Field(
|
|
1783
|
+
None,
|
|
1784
|
+
alias='outputRefIds',
|
|
1785
|
+
description='Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId .',
|
|
1786
|
+
)
|
|
1787
|
+
parameters: list[ErrorParameterV3] | None = Field(
|
|
1788
|
+
None,
|
|
1789
|
+
description='This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value .',
|
|
1790
|
+
)
|
|
1791
|
+
subdomain: str | None = Field(
|
|
1792
|
+
None,
|
|
1793
|
+
description="Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.",
|
|
1794
|
+
)
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
class ExtendedProducerResponsibility(EbayModel):
|
|
1798
|
+
enabled_for_variations: bool | None = Field(
|
|
1799
|
+
None,
|
|
1800
|
+
alias='enabledForVariations',
|
|
1801
|
+
description='An indication of whether the attribute can be enabled for listing variations. If the value is true , the attribute may be specified at the variation level.',
|
|
1802
|
+
)
|
|
1803
|
+
name: ExtendedProducerResponsibilityEnum | None = Field(
|
|
1804
|
+
None, description='The name of the attribute included in the policy.'
|
|
1805
|
+
)
|
|
1806
|
+
usage: GenericUsageEnum | None = Field(
|
|
1807
|
+
None,
|
|
1808
|
+
description='The usage guidelines for the attribute, in the specified marketplace.',
|
|
1809
|
+
)
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
class ExtendedProducerResponsibilityPolicy(EbayModel):
|
|
1813
|
+
category_id: str | None = Field(
|
|
1814
|
+
None,
|
|
1815
|
+
alias='categoryId',
|
|
1816
|
+
description='The unique identifier for the category under which the policy applies.',
|
|
1817
|
+
)
|
|
1818
|
+
category_tree_id: str | None = Field(
|
|
1819
|
+
None,
|
|
1820
|
+
alias='categoryTreeId',
|
|
1821
|
+
description='The unique identifier for the category tree under which the policy applies.',
|
|
1822
|
+
)
|
|
1823
|
+
supported_attributes: list[ExtendedProducerResponsibility] | None = Field(
|
|
1824
|
+
None,
|
|
1825
|
+
alias='supportedAttributes',
|
|
1826
|
+
description='The details regarding the attributes included in the policy, such as their usage guidelines and whether they can be specified at the listing variation level.',
|
|
1827
|
+
)
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
class ExtendedProducerResponsibilityPolicyResponse(EbayModel):
|
|
1831
|
+
extended_producer_responsibilities: (
|
|
1832
|
+
list[ExtendedProducerResponsibilityPolicy] | None
|
|
1833
|
+
) = Field(
|
|
1834
|
+
None,
|
|
1835
|
+
alias='extendedProducerResponsibilities',
|
|
1836
|
+
description='An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace.',
|
|
1837
|
+
)
|
|
1838
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
1839
|
+
None, description='A collection of warnings generated for the request.'
|
|
1840
|
+
)
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
class GetCurrenciesResponse(EbayModel):
|
|
1844
|
+
default_currency: Currency | None = Field(
|
|
1845
|
+
None,
|
|
1846
|
+
alias='defaultCurrency',
|
|
1847
|
+
description='This field specifies the default currency used by the marketplace.',
|
|
1848
|
+
)
|
|
1849
|
+
marketplace_id: MarketplaceIdEnum | None = Field(
|
|
1850
|
+
None,
|
|
1851
|
+
alias='marketplaceId',
|
|
1852
|
+
description='The ID of the eBay marketplace to which the default currency applies.',
|
|
1853
|
+
)
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
class HazardousMaterialDetailsResponse(EbayModel):
|
|
1857
|
+
signal_words: list[SignalWord] | None = Field(
|
|
1858
|
+
None,
|
|
1859
|
+
alias='signalWords',
|
|
1860
|
+
description='This array contains available hazardous materials signal words for the specified marketplace.',
|
|
1861
|
+
)
|
|
1862
|
+
statements: list[HazardStatement] | None = Field(
|
|
1863
|
+
None,
|
|
1864
|
+
description='This array contains available hazardous materials hazard statements for the specified marketplace.',
|
|
1865
|
+
)
|
|
1866
|
+
pictograms: list[Pictogram] | None = Field(
|
|
1867
|
+
None,
|
|
1868
|
+
description='This array contains available hazardous materials hazard pictograms for the specified marketplace.',
|
|
1869
|
+
)
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
class ItemConditionDescriptorConstraint(EbayModel):
|
|
1873
|
+
applicable_to_condition_descriptor_ids: list[str] | None = Field(
|
|
1874
|
+
None,
|
|
1875
|
+
alias='applicableToConditionDescriptorIds',
|
|
1876
|
+
description='This array is returned if the corresponding condition descriptor requires that one or more other associated condition descriptors must also be specified in a listing. The condition descriptor IDs for the associated condition descriptors are returned here. For example, the Grade and Grader condition descriptors must always be specified together in a listing for Graded cards.',
|
|
1877
|
+
)
|
|
1878
|
+
cardinality: CardinalityEnum | None = Field(
|
|
1879
|
+
None,
|
|
1880
|
+
description='The value returned in this field indicates whether a condition descriptor can have a single value or multiple values.',
|
|
1881
|
+
)
|
|
1882
|
+
default_condition_descriptor_value_id: str | None = Field(
|
|
1883
|
+
None,
|
|
1884
|
+
alias='defaultConditionDescriptorValueId',
|
|
1885
|
+
description='The default condition descriptor value that will be set if there are multiple values.',
|
|
1886
|
+
)
|
|
1887
|
+
max_length: int | None = Field(
|
|
1888
|
+
None,
|
|
1889
|
+
alias='maxLength',
|
|
1890
|
+
description='The maximum characters allowed for a condition descriptor. This field is only returned/applicable for condition descriptors that allow free text for condition descriptor values.',
|
|
1891
|
+
)
|
|
1892
|
+
mode: ModeEnum | None = Field(
|
|
1893
|
+
None,
|
|
1894
|
+
description='The value returned in this field indicates whether the supported values for a condition descriptor are predefined or if the seller manually specified the value. Note: FREE_TEXT is currently only applicable to the Certification Number condition descriptor.',
|
|
1895
|
+
)
|
|
1896
|
+
usage: DescriptorUsageEnum | None = Field(
|
|
1897
|
+
None,
|
|
1898
|
+
description='This value indicates whether or not the condition descriptor is required for the item condition. Currently, this field is only returned if the condition descriptor is required for the item condition.',
|
|
1899
|
+
)
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
class ItemConditionDescriptorValue(EbayModel):
|
|
1903
|
+
condition_descriptor_value_additional_help_text: list[str] | None = Field(
|
|
1904
|
+
None,
|
|
1905
|
+
alias='conditionDescriptorValueAdditionalHelpText',
|
|
1906
|
+
description='Additional information about the the condition of the item that is not included in the conditionDescriptorValueHelpText field.',
|
|
1907
|
+
)
|
|
1908
|
+
condition_descriptor_value_constraints: (
|
|
1909
|
+
list[ItemConditionDescriptorValueConstraint] | None
|
|
1910
|
+
) = Field(
|
|
1911
|
+
None,
|
|
1912
|
+
alias='conditionDescriptorValueConstraints',
|
|
1913
|
+
description='The constraints on a condition descriptor value, such as which descriptor value IDs and Descriptor ID it is associated with.',
|
|
1914
|
+
)
|
|
1915
|
+
condition_descriptor_value_help_text: str | None = Field(
|
|
1916
|
+
None,
|
|
1917
|
+
alias='conditionDescriptorValueHelpText',
|
|
1918
|
+
description='A detailed description of the condition descriptor value.',
|
|
1919
|
+
)
|
|
1920
|
+
condition_descriptor_value_id: str | None = Field(
|
|
1921
|
+
None,
|
|
1922
|
+
alias='conditionDescriptorValueId',
|
|
1923
|
+
description='The unique identification number of a condition descriptor value associated with the conditionDescriptorValueName .',
|
|
1924
|
+
)
|
|
1925
|
+
condition_descriptor_value_name: str | None = Field(
|
|
1926
|
+
None,
|
|
1927
|
+
alias='conditionDescriptorValueName',
|
|
1928
|
+
description='The human-readable label for the condition descriptor value associated with the conditionDescriptorValueID .',
|
|
1929
|
+
)
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
class ListingDuration(EbayModel):
|
|
1933
|
+
duration_values: list[DurationEnum] | None = Field(
|
|
1934
|
+
None,
|
|
1935
|
+
alias='durationValues',
|
|
1936
|
+
description='This array defines the supported time duration options available for the listing type.',
|
|
1937
|
+
)
|
|
1938
|
+
listing_type: ListingTypeEnum | None = Field(
|
|
1939
|
+
None,
|
|
1940
|
+
alias='listingType',
|
|
1941
|
+
description='The enumerated value returned in this field indicates the listing type for the duration value(s).',
|
|
1942
|
+
)
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
class ListingStructurePolicyResponse(EbayModel):
|
|
1946
|
+
listing_structure_policies: list[ListingStructurePolicy] | None = Field(
|
|
1947
|
+
None,
|
|
1948
|
+
alias='listingStructurePolicies',
|
|
1949
|
+
description='Returns a list of category IDs plus a flag indicating whether or not each listed category supports item variations.',
|
|
1950
|
+
)
|
|
1951
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
1952
|
+
None,
|
|
1953
|
+
description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
1954
|
+
)
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
class ListingTypePolicy(EbayModel):
|
|
1958
|
+
category_id: str | None = Field(
|
|
1959
|
+
None,
|
|
1960
|
+
alias='categoryId',
|
|
1961
|
+
description='The unique identifier of the eBay leaf category for which metadata is being returned.',
|
|
1962
|
+
)
|
|
1963
|
+
category_tree_id: str | None = Field(
|
|
1964
|
+
None,
|
|
1965
|
+
alias='categoryTreeId',
|
|
1966
|
+
description='The unique identifier of the category tree.',
|
|
1967
|
+
)
|
|
1968
|
+
digital_good_delivery_enabled: bool | None = Field(
|
|
1969
|
+
None,
|
|
1970
|
+
alias='digitalGoodDeliveryEnabled',
|
|
1971
|
+
description="A true value in this field indicates that the leaf category supports the listing of items (such as gift cards) that can be delivered electronically via a download link or sent to a buyer's email address.",
|
|
1972
|
+
)
|
|
1973
|
+
listing_durations: list[ListingDuration] | None = Field(
|
|
1974
|
+
None,
|
|
1975
|
+
alias='listingDurations',
|
|
1976
|
+
description='An array of eBay listing types and the supported durations for the corresponding leaf category. If a specific eBay listing type does not appear for a leaf category, it indicates that the category does not support that listing type.',
|
|
1977
|
+
)
|
|
1978
|
+
pickup_drop_off_enabled: bool | None = Field(
|
|
1979
|
+
None,
|
|
1980
|
+
alias='pickupDropOffEnabled',
|
|
1981
|
+
description="A true value in this field indicates that items listed in the category (specified in the listingTypePolicies.categoryId field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available.",
|
|
1982
|
+
)
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
class MinimumListingPricePoliciesType(EbayModel):
|
|
1986
|
+
description: str | None = Field(
|
|
1987
|
+
None,
|
|
1988
|
+
description='The description of the listing type for which the pricing data is intended, such as "Pricing for the auction-like listings".',
|
|
1989
|
+
)
|
|
1990
|
+
listing_type: ListingTypeEnum | None = Field(
|
|
1991
|
+
None,
|
|
1992
|
+
alias='listingType',
|
|
1993
|
+
description='This enum value indicates the listing type for which minimum starting price policies are being returned. Note: The only applicable values for this method are AUCTION and FIXED_PRICE_ITEM .',
|
|
1994
|
+
)
|
|
1995
|
+
min_buy_it_now_price_percent: str | None = Field(
|
|
1996
|
+
None,
|
|
1997
|
+
alias='minBuyItNowPricePercent',
|
|
1998
|
+
description='The minimum percentage value that a Buy It Now price for an auction listing must be above the starting bid price for the same listing. This field is only returned and applicable for auction listings.',
|
|
1999
|
+
)
|
|
2000
|
+
start_price: Amount | None = Field(
|
|
2001
|
+
None,
|
|
2002
|
+
alias='startPrice',
|
|
2003
|
+
description="For auction listings, this field indicates the lowest dollar value that can be set for the item's starting bid. For fixed-price listings, this field indicates the lower dollar value that can be set for the item's sale price.",
|
|
2004
|
+
)
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
class MotorsListingPoliciesResponse(EbayModel):
|
|
2008
|
+
motors_listing_policies: list[MotorsListingPolicy] | None = Field(
|
|
2009
|
+
None,
|
|
2010
|
+
alias='motorsListingPolicies',
|
|
2011
|
+
description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .',
|
|
2012
|
+
)
|
|
2013
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2014
|
+
None,
|
|
2015
|
+
description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2016
|
+
)
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
class MultiCompatibilityPropertyValuesRequest(EbayModel):
|
|
2020
|
+
category_id: str | None = Field(
|
|
2021
|
+
None,
|
|
2022
|
+
alias='categoryId',
|
|
2023
|
+
description='The unique identifier of the eBay leaf category for which to retrieve property values. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility.',
|
|
2024
|
+
)
|
|
2025
|
+
property_filters: list[PropertyFilterInner] | None = Field(
|
|
2026
|
+
None,
|
|
2027
|
+
alias='propertyFilters',
|
|
2028
|
+
description='This array can be used to specify the compatibility properties used to limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to Year and the propertyValue is set to 2022 , only compatible vehicles from 2022 will be returned. At least one property name-value pair must be used.',
|
|
2029
|
+
)
|
|
2030
|
+
property_names: list[str] | None = Field(
|
|
2031
|
+
None,
|
|
2032
|
+
alias='propertyNames',
|
|
2033
|
+
description="This comma-delimited array specifies the names of the properties for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.",
|
|
2034
|
+
)
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
class MultiCompatibilityPropertyValuesResponse(EbayModel):
|
|
2038
|
+
compatibilities: list[Compatibility] | None = Field(
|
|
2039
|
+
None,
|
|
2040
|
+
description='This container defines the compatibility details associated with the specified property name value(s).',
|
|
2041
|
+
)
|
|
2042
|
+
metadata_version: str | None = Field(
|
|
2043
|
+
None,
|
|
2044
|
+
alias='metadataVersion',
|
|
2045
|
+
description='The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace.',
|
|
2046
|
+
)
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
class NegotiatedPricePolicyResponse(EbayModel):
|
|
2050
|
+
negotiated_price_policies: list[NegotiatedPricePolicy] | None = Field(
|
|
2051
|
+
None,
|
|
2052
|
+
alias='negotiatedPricePolicies',
|
|
2053
|
+
description='A list of category IDs and the policies related to negotiated-price items for each of the listed categories.',
|
|
2054
|
+
)
|
|
2055
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2056
|
+
None,
|
|
2057
|
+
description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2058
|
+
)
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
class ProductResponseCompatibilityDetails(EbayModel):
|
|
2062
|
+
note_details: list[PropertyFilterInner] | None = Field(
|
|
2063
|
+
None,
|
|
2064
|
+
alias='noteDetails',
|
|
2065
|
+
description='This array returns additional comments about the corresponding product in the form of name-value pairs.',
|
|
2066
|
+
)
|
|
2067
|
+
product_details: list[PropertyValues] | None = Field(
|
|
2068
|
+
None,
|
|
2069
|
+
alias='productDetails',
|
|
2070
|
+
description='This array returns details about the product in the form of name-value pairs.',
|
|
2071
|
+
)
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
class PropertyNamesResponseProperties(EbayModel):
|
|
2075
|
+
dataset: str | None = Field(
|
|
2076
|
+
None,
|
|
2077
|
+
description='This field defines the types of properties are returned for the specified catalog-enabled category. Valid values: DisplayableProductDetails : Properties for use in a user interface to describe products. DisplayableSearchResults : Properties for use in results for product searches. Searchable : Properties for use in searches. Sortable : Properties that are suitable for sorting.',
|
|
2078
|
+
)
|
|
2079
|
+
property_names: list[PropertyNamesResponsePropertyNames] | None = Field(
|
|
2080
|
+
None,
|
|
2081
|
+
alias='propertyNames',
|
|
2082
|
+
description="This array specifies the names of the properties associated with the specified category in the specified marketplace. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.",
|
|
2083
|
+
)
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
class RegulatoryAttribute(EbayModel):
|
|
2087
|
+
name: RegulatoryAttributeEnum | None = Field(
|
|
2088
|
+
None, description='A unique value identifying a specific regulatory attribute.'
|
|
2089
|
+
)
|
|
2090
|
+
usage: GenericUsageEnum | None = Field(
|
|
2091
|
+
None,
|
|
2092
|
+
description='The enumeration value in this field indicates whether the corresponding attribute is recommended or required for the corresponding leaf category.',
|
|
2093
|
+
)
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
class RegulatoryPolicy(EbayModel):
|
|
2097
|
+
category_id: str | None = Field(
|
|
2098
|
+
None,
|
|
2099
|
+
alias='categoryId',
|
|
2100
|
+
description='The unique identifier of the leaf category to which the corresponding policies pertain.',
|
|
2101
|
+
)
|
|
2102
|
+
category_tree_id: str | None = Field(
|
|
2103
|
+
None,
|
|
2104
|
+
alias='categoryTreeId',
|
|
2105
|
+
description='The unique identifier of the category tree, which reflects the specified marketplace.',
|
|
2106
|
+
)
|
|
2107
|
+
supported_attributes: list[RegulatoryAttribute] | None = Field(
|
|
2108
|
+
None,
|
|
2109
|
+
alias='supportedAttributes',
|
|
2110
|
+
description='A list of supported regulatory attributes for this marketplace.',
|
|
2111
|
+
)
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
class RegulatoryPolicyResponse(EbayModel):
|
|
2115
|
+
regulatory_policies: list[RegulatoryPolicy] | None = Field(
|
|
2116
|
+
None,
|
|
2117
|
+
alias='regulatoryPolicies',
|
|
2118
|
+
description='A list of eBay policies that define whether or not you must include required regulatory information for leaf categories on the given marketplace.',
|
|
2119
|
+
)
|
|
2120
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2121
|
+
None,
|
|
2122
|
+
description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2123
|
+
)
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
class ShippingPolicy(EbayModel):
|
|
2127
|
+
category_id: str | None = Field(
|
|
2128
|
+
None,
|
|
2129
|
+
alias='categoryId',
|
|
2130
|
+
description='The unique identifier of the eBay leaf category for which metadata is being returned.',
|
|
2131
|
+
)
|
|
2132
|
+
category_tree_id: str | None = Field(
|
|
2133
|
+
None,
|
|
2134
|
+
alias='categoryTreeId',
|
|
2135
|
+
description='The unique identifier of the category tree.',
|
|
2136
|
+
)
|
|
2137
|
+
global_shipping_enabled: bool | None = Field(
|
|
2138
|
+
None,
|
|
2139
|
+
alias='globalShippingEnabled',
|
|
2140
|
+
description='Indicates if the Global Shipping Program (GSP) is supported for the category. Note: GSP is only supported by the eBay UK marketplace ( EBAY_GB ).',
|
|
2141
|
+
)
|
|
2142
|
+
group1_max_flat_shipping_cost: Amount | None = Field(
|
|
2143
|
+
None,
|
|
2144
|
+
alias='group1MaxFlatShippingCost',
|
|
2145
|
+
description='Returns the applicable max cap per shipping cost for shipping service group1.',
|
|
2146
|
+
)
|
|
2147
|
+
group2_max_flat_shipping_cost: Amount | None = Field(
|
|
2148
|
+
None,
|
|
2149
|
+
alias='group2MaxFlatShippingCost',
|
|
2150
|
+
description='Returns the applicable max cap per shipping cost for shipping service group2.',
|
|
2151
|
+
)
|
|
2152
|
+
group3_max_flat_shipping_cost: Amount | None = Field(
|
|
2153
|
+
None,
|
|
2154
|
+
alias='group3MaxFlatShippingCost',
|
|
2155
|
+
description='Returns the applicable max cap per shipping cost for shipping service group3.',
|
|
2156
|
+
)
|
|
2157
|
+
handling_time_enabled: bool | None = Field(
|
|
2158
|
+
None,
|
|
2159
|
+
alias='handlingTimeEnabled',
|
|
2160
|
+
description="Indicates if a seller's stated handling time is enabled for a category. A handling time is generally needed for items that are shipped to the buyer, but not necessarily applicable to freight shipping or local pickup.",
|
|
2161
|
+
)
|
|
2162
|
+
max_flat_shipping_cost: Amount | None = Field(
|
|
2163
|
+
None,
|
|
2164
|
+
alias='maxFlatShippingCost',
|
|
2165
|
+
description='The maximum cost the seller can charge for the first domestic flat-rate shipping service. Mutually exclusive with the GroupNMaxFlatShippingCost elements.',
|
|
2166
|
+
)
|
|
2167
|
+
shipping_terms_required: bool | None = Field(
|
|
2168
|
+
None,
|
|
2169
|
+
alias='shippingTermsRequired',
|
|
2170
|
+
description='Indicates whether the category requires sellers to specify shipping details at listing time.',
|
|
2171
|
+
)
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
class SiteVisibilityPoliciesResponse(EbayModel):
|
|
2175
|
+
site_visibility_policies: list[SiteVisibilityPolicy] | None = Field(
|
|
2176
|
+
None,
|
|
2177
|
+
alias='siteVisibilityPolicies',
|
|
2178
|
+
description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .',
|
|
2179
|
+
)
|
|
2180
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2181
|
+
None,
|
|
2182
|
+
description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2183
|
+
)
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
class SortOrderInner(EbayModel):
|
|
2187
|
+
sort_order: SortOrderProperties | None = Field(
|
|
2188
|
+
None,
|
|
2189
|
+
alias='sortOrder',
|
|
2190
|
+
description='This container is used to define the property to be used in the sorting.',
|
|
2191
|
+
)
|
|
2192
|
+
sort_priority: str | None = Field(
|
|
2193
|
+
None,
|
|
2194
|
+
alias='sortPriority',
|
|
2195
|
+
description='The priority of the specified sort order provided. For example, when a property is assigned Sort1 , its values are sorted first. Values for the property assigned Sort2 are sorted second, and so on. Valid values : Sort1 Sort2 Sort3 Sort4 Sort5',
|
|
2196
|
+
)
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
class SpecificationRequest(EbayModel):
|
|
2200
|
+
category_id: str | None = Field(
|
|
2201
|
+
None,
|
|
2202
|
+
alias='categoryId',
|
|
2203
|
+
description='The unique identifier of the eBay leaf category for which compatibility details are being retrieved. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.',
|
|
2204
|
+
)
|
|
2205
|
+
compatibility_property_filters: list[PropertyFilterInner] | None = Field(
|
|
2206
|
+
None,
|
|
2207
|
+
alias='compatibilityPropertyFilters',
|
|
2208
|
+
description='This comma-delimited array can be used to restrict the number of compatible application name-value pairs returned in the response by specifying the properties that the seller wishes to be included in the response. Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim.',
|
|
2209
|
+
)
|
|
2210
|
+
dataset: str | None = Field(
|
|
2211
|
+
None,
|
|
2212
|
+
description='This field can be used to define the type of properties that will be returned in the response. For example, if you specify Searchable , the compatibility details will contain properties that can be used to search for products, such as make or model. Note: This field cannot be used alongside dataPropertyName . If both are used, an error will occur.',
|
|
2213
|
+
)
|
|
2214
|
+
dataset_property_name: list[str] | None = Field(
|
|
2215
|
+
None,
|
|
2216
|
+
alias='datasetPropertyName',
|
|
2217
|
+
description='This comma-delimited array can be used to define the specific property name(s) that will be returned in the response. For example, if you specify Engine , the result set will only contain engines that are compatible with the input criteria. Note: This array cannot be used alongside dataset . If both are used, an error will occur.',
|
|
2218
|
+
)
|
|
2219
|
+
exact_match: bool | None = Field(
|
|
2220
|
+
None,
|
|
2221
|
+
alias='exactMatch',
|
|
2222
|
+
description='This boolean can be used to specify that the compatibilities returned in the response are to be defined by an exact match on the input value of specification properties. By default, an expanded compatibility match is done when it applies, such as for Load Index, where a compatible vehicle is one that has a load index requirement that is less than or equal to the input.',
|
|
2223
|
+
)
|
|
2224
|
+
pagination_input: PaginationInput | None = Field(
|
|
2225
|
+
None,
|
|
2226
|
+
alias='paginationInput',
|
|
2227
|
+
description='Important! Pagination is not yet supported by this method. If this container is included in the request, it will be ignored.',
|
|
2228
|
+
)
|
|
2229
|
+
sort_orders: list[SortOrderInner] | None = Field(
|
|
2230
|
+
None,
|
|
2231
|
+
alias='sortOrders',
|
|
2232
|
+
description='This array specifies the sorting order of the compatibility properties. Any of the searchable properties can be used to specify search order. Up to 5 levels of sort order may be specified. Note: If no sort order is specified through this field, the default sort order of popularity descending is applied.',
|
|
2233
|
+
)
|
|
2234
|
+
specifications: list[PropertyFilterInner] | None = Field(
|
|
2235
|
+
None,
|
|
2236
|
+
description='This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved.',
|
|
2237
|
+
)
|
|
2238
|
+
|
|
2239
|
+
|
|
2240
|
+
class SpecificationResponse(EbayModel):
|
|
2241
|
+
compatibility_details: list[Compatibility] | None = Field(
|
|
2242
|
+
None,
|
|
2243
|
+
alias='compatibilityDetails',
|
|
2244
|
+
description='This container returns the list of all compatible application name-value pairs for the given filter criteria.',
|
|
2245
|
+
)
|
|
2246
|
+
pagination: Pagination | None = Field(
|
|
2247
|
+
None, description='Important! Not currently returned. For future use.'
|
|
2248
|
+
)
|
|
2249
|
+
|
|
2250
|
+
|
|
2251
|
+
class TimeDuration(EbayModel):
|
|
2252
|
+
unit: TimeDurationUnitEnum | None = Field(
|
|
2253
|
+
None,
|
|
2254
|
+
description='A time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit . Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units.',
|
|
2255
|
+
)
|
|
2256
|
+
value: int | None = Field(
|
|
2257
|
+
None,
|
|
2258
|
+
description='An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.',
|
|
2259
|
+
)
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
class AutomotivePartsCompatibilityPolicyResponse(EbayModel):
|
|
2263
|
+
automotive_parts_compatibility_policies: (
|
|
2264
|
+
list[AutomotivePartsCompatibilityPolicy] | None
|
|
2265
|
+
) = Field(
|
|
2266
|
+
None,
|
|
2267
|
+
alias='automotivePartsCompatibilityPolicies',
|
|
2268
|
+
description='A list of category IDs and the automotive parts compatibility policies for each of the listed categories.',
|
|
2269
|
+
)
|
|
2270
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2271
|
+
None,
|
|
2272
|
+
description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2273
|
+
)
|
|
2274
|
+
|
|
2275
|
+
|
|
2276
|
+
class CategoryPolicyResponse(EbayModel):
|
|
2277
|
+
category_policies: list[CategoryPolicy] | None = Field(
|
|
2278
|
+
None,
|
|
2279
|
+
alias='categoryPolicies',
|
|
2280
|
+
description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .',
|
|
2281
|
+
)
|
|
2282
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2283
|
+
None,
|
|
2284
|
+
description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2285
|
+
)
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
class ClassifiedAdPolicyResponse(EbayModel):
|
|
2289
|
+
classified_ad_policies: list[ClassifiedAdPolicy] | None = Field(
|
|
2290
|
+
None,
|
|
2291
|
+
alias='classifiedAdPolicies',
|
|
2292
|
+
description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .',
|
|
2293
|
+
)
|
|
2294
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2295
|
+
None,
|
|
2296
|
+
description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2297
|
+
)
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
class GetMinimumListingPricePoliciesResponse(EbayModel):
|
|
2301
|
+
minimum_listing_price_policies: list[MinimumListingPricePoliciesType] | None = (
|
|
2302
|
+
Field(
|
|
2303
|
+
None,
|
|
2304
|
+
alias='minimumListingPricePolicies',
|
|
2305
|
+
description='This array returns a list of minimum listing price policies for supported types of listings on the specific marketplace',
|
|
2306
|
+
)
|
|
2307
|
+
)
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
class ItemConditionDescriptor(EbayModel):
|
|
2311
|
+
condition_descriptor_constraint: ItemConditionDescriptorConstraint | None = Field(
|
|
2312
|
+
None,
|
|
2313
|
+
alias='conditionDescriptorConstraint',
|
|
2314
|
+
description='This container shows the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs.',
|
|
2315
|
+
)
|
|
2316
|
+
condition_descriptor_help_text: str | None = Field(
|
|
2317
|
+
None,
|
|
2318
|
+
alias='conditionDescriptorHelpText',
|
|
2319
|
+
description='A description of the condition descriptor that directs a user to its condition descriptor values. For example, the help text for Card Condition is Select ungraded condition .',
|
|
2320
|
+
)
|
|
2321
|
+
condition_descriptor_id: str | None = Field(
|
|
2322
|
+
None,
|
|
2323
|
+
alias='conditionDescriptorId',
|
|
2324
|
+
description='The unique identification number of a condition descriptor associated with with a conditionDescriptorName . For example, 40001 is the ID for Card Condition . These IDs are used in the addItem family of calls of the Trading API to provide condition descriptor names for the item.',
|
|
2325
|
+
)
|
|
2326
|
+
condition_descriptor_name: str | None = Field(
|
|
2327
|
+
None,
|
|
2328
|
+
alias='conditionDescriptorName',
|
|
2329
|
+
description='The human-readable label for the condition descriptor associated with the conditionDescriptorID . For example, Card Condition is the condition descriptor name for ID 40001',
|
|
2330
|
+
)
|
|
2331
|
+
condition_descriptor_values: list[ItemConditionDescriptorValue] | None = Field(
|
|
2332
|
+
None,
|
|
2333
|
+
alias='conditionDescriptorValues',
|
|
2334
|
+
description='This array shows the possible values that map to the corresponding conditionDescriptorName values. Constraint information and help text are also shown for each value. For example, The ID 40001 is ID for the condition descriptor card condition . The ID 400012 is the ID for the Very Good card condition value.',
|
|
2335
|
+
)
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
class ListingTypePoliciesResponse(EbayModel):
|
|
2339
|
+
listing_type_policies: list[ListingTypePolicy] | None = Field(
|
|
2340
|
+
None,
|
|
2341
|
+
alias='listingTypePolicies',
|
|
2342
|
+
description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .',
|
|
2343
|
+
)
|
|
2344
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2345
|
+
None,
|
|
2346
|
+
description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2347
|
+
)
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
class ProductRequest(EbayModel):
|
|
2351
|
+
application_property_filters: list[PropertyFilterInner] | None = Field(
|
|
2352
|
+
None,
|
|
2353
|
+
alias='applicationPropertyFilters',
|
|
2354
|
+
description="This array is used to filter the properties of an application, such as a vehicle's make or model, that will be returned in the response. Application property filters are specified as name-value pairs. Only products compatible with these name-value pairs will be returned.",
|
|
2355
|
+
)
|
|
2356
|
+
dataset: list[str] | None = Field(
|
|
2357
|
+
None,
|
|
2358
|
+
description='This array defines the type of properties that are returned for the catalog-enabled category. For example, if you specify Searchable , the compatibility details will contain properties that can be used to search for products, such as make or model. Note: This field cannot be used alongside dataPropertyName . If both are used, an error will occur.',
|
|
2359
|
+
)
|
|
2360
|
+
dataset_property_name: list[str] | None = Field(
|
|
2361
|
+
None,
|
|
2362
|
+
alias='datasetPropertyName',
|
|
2363
|
+
description='This comma-delimted array can be used to define the specific property name(s) that will be returned in the response. For example, if you specify Engine , the result set will only contain engines that are compatible with the input criteria. Note: This array cannot be used alongside dataset . If both are used, an error will occur.',
|
|
2364
|
+
)
|
|
2365
|
+
disabled_product_filter: DisabledProductFilter | None = Field(
|
|
2366
|
+
None,
|
|
2367
|
+
alias='disabledProductFilter',
|
|
2368
|
+
description='This container can be used to specify whether or not to filter out products which are disabled for selling on eBay and/or disabled for product review.',
|
|
2369
|
+
)
|
|
2370
|
+
pagination_input: PaginationInput | None = Field(
|
|
2371
|
+
None,
|
|
2372
|
+
alias='paginationInput',
|
|
2373
|
+
description='This container controls the pagination of the result set.',
|
|
2374
|
+
)
|
|
2375
|
+
product_identifier: ProductIdentifier | None = Field(
|
|
2376
|
+
None,
|
|
2377
|
+
alias='productIdentifier',
|
|
2378
|
+
description='This container is used to provide unique identifier for the product. The product identifier consists of an identifier type and value, and are unique across all sites.',
|
|
2379
|
+
)
|
|
2380
|
+
sort_orders: list[SortOrderInner] | None = Field(
|
|
2381
|
+
None,
|
|
2382
|
+
alias='sortOrders',
|
|
2383
|
+
description='This array controls the sort order of compatibility properties.',
|
|
2384
|
+
)
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
class ProductResponse(EbayModel):
|
|
2388
|
+
compatibility_details: list[ProductResponseCompatibilityDetails] | None = Field(
|
|
2389
|
+
None,
|
|
2390
|
+
alias='compatibilityDetails',
|
|
2391
|
+
description='This container provides compatibility details for the specified product.',
|
|
2392
|
+
)
|
|
2393
|
+
pagination: Pagination | None = Field(
|
|
2394
|
+
None,
|
|
2395
|
+
description='This container returns the pagination settings for the result set.',
|
|
2396
|
+
)
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
class PropertyNamesResponse(EbayModel):
|
|
2400
|
+
category_id: str | None = Field(
|
|
2401
|
+
None,
|
|
2402
|
+
alias='categoryId',
|
|
2403
|
+
description='The unique identifier of the eBay category specified in the request.',
|
|
2404
|
+
)
|
|
2405
|
+
properties: list[PropertyNamesResponseProperties] | None = Field(
|
|
2406
|
+
None,
|
|
2407
|
+
description='This array contains all of the properties for the specified category.',
|
|
2408
|
+
)
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
class ReturnPolicyDetails(EbayModel):
|
|
2412
|
+
policy_description_enabled: bool | None = Field(
|
|
2413
|
+
None,
|
|
2414
|
+
alias='policyDescriptionEnabled',
|
|
2415
|
+
description="If set to true , this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the returnInstructions field in the Account API's createReturnPolicy ). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces.",
|
|
2416
|
+
)
|
|
2417
|
+
refund_methods: list[RefundMethodEnum] | None = Field(
|
|
2418
|
+
None,
|
|
2419
|
+
alias='refundMethods',
|
|
2420
|
+
description='A list of refund methods allowed for the associated category. Note: Depending on the API used to setup your return policy, available refund methods are defined differently.',
|
|
2421
|
+
)
|
|
2422
|
+
return_methods: list[ReturnMethodEnum] | None = Field(
|
|
2423
|
+
None,
|
|
2424
|
+
alias='returnMethods',
|
|
2425
|
+
description='A list of return methods allowed for the associated category. Note: Depending on the API used to setup your return policy, available return methods are defined differently.',
|
|
2426
|
+
)
|
|
2427
|
+
return_periods: list[TimeDuration] | None = Field(
|
|
2428
|
+
None,
|
|
2429
|
+
alias='returnPeriods',
|
|
2430
|
+
description='A list of return periods allowed for the associated category. Note: Depending on the API used to setup your return policy, return periods are defined differently. Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use the returnPeriod and internationalOverride.returnPeriod containers to set the return period(s) for the business policy.',
|
|
2431
|
+
)
|
|
2432
|
+
returns_acceptance_enabled: bool | None = Field(
|
|
2433
|
+
None,
|
|
2434
|
+
alias='returnsAcceptanceEnabled',
|
|
2435
|
+
description='A value of true in this field indicates that return policies are applicable to the corresponding leaf category.',
|
|
2436
|
+
)
|
|
2437
|
+
return_shipping_cost_payers: list[ReturnShippingCostPayerEnum] | None = Field(
|
|
2438
|
+
None,
|
|
2439
|
+
alias='returnShippingCostPayers',
|
|
2440
|
+
description='A list of allowed values for who pays for the return shipping cost. Note that for SNAD returns, the seller is always responsible for the return shipping cost. Note: Depending on the API used to setup your return policy, specifiying that the buyer or seller is responsible for paying for return shipping costs is defined differently.',
|
|
2441
|
+
)
|
|
2442
|
+
|
|
2443
|
+
|
|
2444
|
+
class ShippingPoliciesResponse(EbayModel):
|
|
2445
|
+
shipping_policies: list[ShippingPolicy] | None = Field(
|
|
2446
|
+
None,
|
|
2447
|
+
alias='shippingPolicies',
|
|
2448
|
+
description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .',
|
|
2449
|
+
)
|
|
2450
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2451
|
+
None,
|
|
2452
|
+
description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2453
|
+
)
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
class ItemCondition(EbayModel):
|
|
2457
|
+
condition_description: str | None = Field(
|
|
2458
|
+
None,
|
|
2459
|
+
alias='conditionDescription',
|
|
2460
|
+
description='The human-readable label for the condition (e.g., "New"). This value is typically localized for each site. Note that the display name can vary by category. For example, the description for condition ID 1000 could be called "New: with Tags" in one category and "Brand New" in another. For details on condition IDs and descriptions, see Item condition ID and name values .',
|
|
2461
|
+
)
|
|
2462
|
+
condition_descriptors: list[ItemConditionDescriptor] | None = Field(
|
|
2463
|
+
None,
|
|
2464
|
+
alias='conditionDescriptors',
|
|
2465
|
+
description='This array contains the possible condition descriptors and condition descriptor values applicable for the specified category. It also returns usage requirements, maximum length, cardinality, and help text. Note: This array is only returned for categories that support condition descriptors.',
|
|
2466
|
+
)
|
|
2467
|
+
condition_help_text: str | None = Field(
|
|
2468
|
+
None,
|
|
2469
|
+
alias='conditionHelpText',
|
|
2470
|
+
description='A detailed description of the condition denoted by the conditionID and conditionDescription .',
|
|
2471
|
+
)
|
|
2472
|
+
condition_id: str | None = Field(
|
|
2473
|
+
None,
|
|
2474
|
+
alias='conditionId',
|
|
2475
|
+
description='The ID value of the selected item condition. For information on the supported condition ID values, see Item condition ID and name values .',
|
|
2476
|
+
)
|
|
2477
|
+
usage: UsageEnum | None = Field(
|
|
2478
|
+
None,
|
|
2479
|
+
description="The value returned in this field indicates if there are any usage restrictions or requirements for the corresponding item condition in the corresponding category. Note: Currently, the only supported value is 'RESTRICTED', and this field will only be returned for the following conditions: 2000, 2010, 2020, 2030. Sellers must be pre-approved to use any of these item conditions.",
|
|
2480
|
+
)
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
class ItemConditionPolicy(EbayModel):
|
|
2484
|
+
category_id: str | None = Field(
|
|
2485
|
+
None,
|
|
2486
|
+
alias='categoryId',
|
|
2487
|
+
description='The category ID to which the item-condition policy applies.',
|
|
2488
|
+
)
|
|
2489
|
+
category_tree_id: str | None = Field(
|
|
2490
|
+
None,
|
|
2491
|
+
alias='categoryTreeId',
|
|
2492
|
+
description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.',
|
|
2493
|
+
)
|
|
2494
|
+
item_condition_required: bool | None = Field(
|
|
2495
|
+
None,
|
|
2496
|
+
alias='itemConditionRequired',
|
|
2497
|
+
description='This flag denotes whether or not you must list the item condition in a listing for the specified category. If set to true , you must specify an item condition for the associated category.',
|
|
2498
|
+
)
|
|
2499
|
+
item_conditions: list[ItemCondition] | None = Field(
|
|
2500
|
+
None,
|
|
2501
|
+
alias='itemConditions',
|
|
2502
|
+
description="The item-condition values allowed in the category. Note: The ‘Seller Refurbished’ item condition (condition ID 2500) has been replaced by the 'Excellent - Refurbished', 'Very Good - Refurbished', and 'Good - Refurbished' item conditions in a select number of eBay marketplaces and categories.",
|
|
2503
|
+
)
|
|
2504
|
+
|
|
2505
|
+
|
|
2506
|
+
class ItemConditionPolicyResponse(EbayModel):
|
|
2507
|
+
item_condition_policies: list[ItemConditionPolicy] | None = Field(
|
|
2508
|
+
None,
|
|
2509
|
+
alias='itemConditionPolicies',
|
|
2510
|
+
description="A list of category IDs and the policies for how to indicate an item's condition in each of the listed categories.",
|
|
2511
|
+
)
|
|
2512
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2513
|
+
None,
|
|
2514
|
+
description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2515
|
+
)
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
class ReturnPolicy(EbayModel):
|
|
2519
|
+
category_id: str | None = Field(
|
|
2520
|
+
None,
|
|
2521
|
+
alias='categoryId',
|
|
2522
|
+
description='The category ID to which the return policies apply.',
|
|
2523
|
+
)
|
|
2524
|
+
category_tree_id: str | None = Field(
|
|
2525
|
+
None,
|
|
2526
|
+
alias='categoryTreeId',
|
|
2527
|
+
description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.',
|
|
2528
|
+
)
|
|
2529
|
+
domestic: ReturnPolicyDetails | None = Field(
|
|
2530
|
+
None,
|
|
2531
|
+
description='This complex type defines the category policies related to domestic item returns.',
|
|
2532
|
+
)
|
|
2533
|
+
international: ReturnPolicyDetails | None = Field(
|
|
2534
|
+
None,
|
|
2535
|
+
description='This complex type defines the category policies related to international item returns.',
|
|
2536
|
+
)
|
|
2537
|
+
required: bool | None = Field(
|
|
2538
|
+
None,
|
|
2539
|
+
description='If set to true , this flag indicates that you must specify a return policy for items listed in the associated category. Note that not accepting returns (setting returnsAcceptedEnabled to false ) is a valid return policy.',
|
|
2540
|
+
)
|
|
2541
|
+
|
|
2542
|
+
|
|
2543
|
+
class ReturnPolicyResponse(EbayModel):
|
|
2544
|
+
return_policies: list[ReturnPolicy] | None = Field(
|
|
2545
|
+
None,
|
|
2546
|
+
alias='returnPolicies',
|
|
2547
|
+
description='A list of elements, where each contains a category ID and a flag that indicates whether or not listings in that category require a return policy.',
|
|
2548
|
+
)
|
|
2549
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2550
|
+
None,
|
|
2551
|
+
description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.',
|
|
2552
|
+
)
|