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,3162 @@
|
|
|
1
|
+
# ruff: noqa
|
|
2
|
+
# generated by datamodel-codegen:
|
|
3
|
+
# filename: buy_browse_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 AddonServiceSelectionEnum(OpenStrEnum):
|
|
14
|
+
optional = 'OPTIONAL'
|
|
15
|
+
required = 'REQUIRED'
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class AddonServiceTypeEnum(OpenStrEnum):
|
|
19
|
+
authenticity_guarantee = 'AUTHENTICITY_GUARANTEE'
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class Aspect(EbayModel):
|
|
23
|
+
localized_name: str | None = Field(
|
|
24
|
+
None,
|
|
25
|
+
alias='localizedName',
|
|
26
|
+
description='The text representing the name of the aspect for the name/value pair, such as Brand.',
|
|
27
|
+
)
|
|
28
|
+
localized_values: list[str] | None = Field(
|
|
29
|
+
None,
|
|
30
|
+
alias='localizedValues',
|
|
31
|
+
description='The text representing the value of the aspect for the name/value pair, such as Apple.',
|
|
32
|
+
)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
class AspectGroup(EbayModel):
|
|
36
|
+
aspects: list[Aspect] | None = Field(
|
|
37
|
+
None,
|
|
38
|
+
description='An array of the name/value pairs for the aspects of the product. For example: BRAND/Apple',
|
|
39
|
+
)
|
|
40
|
+
localized_group_name: str | None = Field(
|
|
41
|
+
None,
|
|
42
|
+
alias='localizedGroupName',
|
|
43
|
+
description='The name of a group of aspects. In the following example, Product Identifiers and Process are product aspect group names. Under the group name are the product aspect name/value pairs. Product Identifiers Brand/Apple Product Family/iMac Processor Processor Type/Intel Processor Speed/3.10',
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
class AspectValueDistribution(EbayModel):
|
|
48
|
+
localized_aspect_value: str | None = Field(
|
|
49
|
+
None,
|
|
50
|
+
alias='localizedAspectValue',
|
|
51
|
+
description='The value of an aspect. For example, Red is a value for the aspect Color.',
|
|
52
|
+
)
|
|
53
|
+
match_count: int | None = Field(
|
|
54
|
+
None, alias='matchCount', description='The number of items with this aspect.'
|
|
55
|
+
)
|
|
56
|
+
refinement_href: str | None = Field(
|
|
57
|
+
None, alias='refinementHref', description='A HATEOAS reference for this aspect.'
|
|
58
|
+
)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
class AttributeNameValue(EbayModel):
|
|
62
|
+
name: str | None = Field(
|
|
63
|
+
None,
|
|
64
|
+
description='The name of the product attribute, such as Make , Model , Year , etc.',
|
|
65
|
+
)
|
|
66
|
+
value: str | None = Field(
|
|
67
|
+
None,
|
|
68
|
+
description='The value for the name attribute, such as BMW , R1200GS , 2011 , etc.',
|
|
69
|
+
)
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
class AuthenticityGuaranteeProgram(EbayModel):
|
|
73
|
+
description: str | None = Field(
|
|
74
|
+
None,
|
|
75
|
+
description='An indication that the item is qualified for the Authenticity Guarantee program.',
|
|
76
|
+
)
|
|
77
|
+
terms_web_url: str | None = Field(
|
|
78
|
+
None,
|
|
79
|
+
alias='termsWebUrl',
|
|
80
|
+
description='The URL to the Authenticity Guarantee program terms of use.',
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
class AuthenticityVerificationProgram(EbayModel):
|
|
85
|
+
description: str | None = Field(
|
|
86
|
+
None, description='An indication that the item is from a verified seller.'
|
|
87
|
+
)
|
|
88
|
+
terms_web_url: str | None = Field(
|
|
89
|
+
None,
|
|
90
|
+
alias='termsWebUrl',
|
|
91
|
+
description='The URL to the Authenticity Verification program terms of use.',
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
class AutoCorrections(EbayModel):
|
|
96
|
+
q: str | None = Field(
|
|
97
|
+
None, description='The automatically spell-corrected keyword from the request.'
|
|
98
|
+
)
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
class AvailabilityStatusEnum(OpenStrEnum):
|
|
102
|
+
in_stock = 'IN_STOCK'
|
|
103
|
+
limited_stock = 'LIMITED_STOCK'
|
|
104
|
+
out_of_stock = 'OUT_OF_STOCK'
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
class AvailabilityThresholdEnum(OpenStrEnum):
|
|
108
|
+
more_than = 'MORE_THAN'
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
class BuyingOptionDistribution(EbayModel):
|
|
112
|
+
buying_option: str | None = Field(
|
|
113
|
+
None,
|
|
114
|
+
alias='buyingOption',
|
|
115
|
+
description='The container that returns the buying option type. This will be AUCTION, FIXED_PRICE, CLASSIFIED_AD, or a combination of these options. For details, see buyingOptions .',
|
|
116
|
+
)
|
|
117
|
+
match_count: int | None = Field(
|
|
118
|
+
None,
|
|
119
|
+
alias='matchCount',
|
|
120
|
+
description='The number of items having this buying option.',
|
|
121
|
+
)
|
|
122
|
+
refinement_href: str | None = Field(
|
|
123
|
+
None,
|
|
124
|
+
alias='refinementHref',
|
|
125
|
+
description='The HATEOAS reference for this buying option.',
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
class Category(EbayModel):
|
|
130
|
+
category_id: str | None = Field(
|
|
131
|
+
None, alias='categoryId', description='The unique identifier of the category.'
|
|
132
|
+
)
|
|
133
|
+
category_name: str | None = Field(
|
|
134
|
+
None, alias='categoryName', description='The name of the category.'
|
|
135
|
+
)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
class CategoryDistribution(EbayModel):
|
|
139
|
+
category_id: str | None = Field(
|
|
140
|
+
None, alias='categoryId', description='The unique identifier of the category.'
|
|
141
|
+
)
|
|
142
|
+
category_name: str | None = Field(
|
|
143
|
+
None,
|
|
144
|
+
alias='categoryName',
|
|
145
|
+
description='The name of the category, such as Baby & Toddler Clothing .',
|
|
146
|
+
)
|
|
147
|
+
match_count: int | None = Field(
|
|
148
|
+
None, alias='matchCount', description='The number of items in this category.'
|
|
149
|
+
)
|
|
150
|
+
refinement_href: str | None = Field(
|
|
151
|
+
None,
|
|
152
|
+
alias='refinementHref',
|
|
153
|
+
description='The HATEOAS reference of this category.',
|
|
154
|
+
)
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
class CommonDescriptions(EbayModel):
|
|
158
|
+
description: str | None = Field(
|
|
159
|
+
None,
|
|
160
|
+
description='The item description that is used by more than one of the item variations.',
|
|
161
|
+
)
|
|
162
|
+
item_ids: list[str] | None = Field(
|
|
163
|
+
None,
|
|
164
|
+
alias='itemIds',
|
|
165
|
+
description='A list of item ids that have this description.',
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
class CompatibilityMatchEnum(OpenStrEnum):
|
|
170
|
+
exact = 'EXACT'
|
|
171
|
+
possible = 'POSSIBLE'
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
class CompatibilityPayload(EbayModel):
|
|
175
|
+
compatibility_properties: list[AttributeNameValue] | None = Field(
|
|
176
|
+
None,
|
|
177
|
+
alias='compatibilityProperties',
|
|
178
|
+
description='An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be "name" : "Year", "value" : "2019" For a list of the attributes required for cars and trucks and motorcycles see Check compatibility in the Buy Integration Guide.',
|
|
179
|
+
)
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
class CompatibilityProperty(EbayModel):
|
|
183
|
+
localized_name: str | None = Field(
|
|
184
|
+
None,
|
|
185
|
+
alias='localizedName',
|
|
186
|
+
description='The name of the product attribute that as been translated to the language of the site.',
|
|
187
|
+
)
|
|
188
|
+
name: str | None = Field(
|
|
189
|
+
None,
|
|
190
|
+
description='The name of the product attribute, such as Make, Model, Year, etc.',
|
|
191
|
+
)
|
|
192
|
+
value: str | None = Field(
|
|
193
|
+
None,
|
|
194
|
+
description='The value for the name attribute, such as BMW , R1200GS , 2011 , etc.',
|
|
195
|
+
)
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
class CompatibilityStatus(OpenStrEnum):
|
|
199
|
+
compatible = 'COMPATIBLE'
|
|
200
|
+
not_compatible = 'NOT_COMPATIBLE'
|
|
201
|
+
undetermined = 'UNDETERMINED'
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
class ConditionDescriptorValue(EbayModel):
|
|
205
|
+
additional_info: list[str] | None = Field(
|
|
206
|
+
None,
|
|
207
|
+
alias='additionalInfo',
|
|
208
|
+
description='Additional information about the condition of an item as it relates to a condition descriptor. This array elaborates on the value specified in the content field and provides additional details about the condition of an item.',
|
|
209
|
+
)
|
|
210
|
+
content: str | None = Field(
|
|
211
|
+
None,
|
|
212
|
+
description='The value for the condition descriptor indicated in the associated name field.',
|
|
213
|
+
)
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
class ConditionDistribution(EbayModel):
|
|
217
|
+
condition: str | None = Field(
|
|
218
|
+
None,
|
|
219
|
+
description='The text describing the condition of the item, such as New or Used . For a list of condition names, refer to Item Condition IDs and Names .',
|
|
220
|
+
)
|
|
221
|
+
condition_id: str | None = Field(
|
|
222
|
+
None,
|
|
223
|
+
alias='conditionId',
|
|
224
|
+
description='The identifier of the condition. For example, 1000 is the identifier for NEW .',
|
|
225
|
+
)
|
|
226
|
+
match_count: int | None = Field(
|
|
227
|
+
None,
|
|
228
|
+
alias='matchCount',
|
|
229
|
+
description='The number of items having the condition.',
|
|
230
|
+
)
|
|
231
|
+
refinement_href: str | None = Field(
|
|
232
|
+
None,
|
|
233
|
+
alias='refinementHref',
|
|
234
|
+
description='The HATEOAS reference of this condition.',
|
|
235
|
+
)
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
class CountryCodeEnum(OpenStrEnum):
|
|
239
|
+
ad = 'AD'
|
|
240
|
+
ae = 'AE'
|
|
241
|
+
af = 'AF'
|
|
242
|
+
ag = 'AG'
|
|
243
|
+
ai = 'AI'
|
|
244
|
+
al = 'AL'
|
|
245
|
+
am = 'AM'
|
|
246
|
+
an = 'AN'
|
|
247
|
+
ao = 'AO'
|
|
248
|
+
aq = 'AQ'
|
|
249
|
+
ar = 'AR'
|
|
250
|
+
as_ = 'AS'
|
|
251
|
+
at = 'AT'
|
|
252
|
+
au = 'AU'
|
|
253
|
+
aw = 'AW'
|
|
254
|
+
ax = 'AX'
|
|
255
|
+
az = 'AZ'
|
|
256
|
+
ba = 'BA'
|
|
257
|
+
bb = 'BB'
|
|
258
|
+
bd = 'BD'
|
|
259
|
+
be = 'BE'
|
|
260
|
+
bf = 'BF'
|
|
261
|
+
bg = 'BG'
|
|
262
|
+
bh = 'BH'
|
|
263
|
+
bi = 'BI'
|
|
264
|
+
bj = 'BJ'
|
|
265
|
+
bl = 'BL'
|
|
266
|
+
bm = 'BM'
|
|
267
|
+
bn = 'BN'
|
|
268
|
+
bo = 'BO'
|
|
269
|
+
bq = 'BQ'
|
|
270
|
+
br = 'BR'
|
|
271
|
+
bs = 'BS'
|
|
272
|
+
bt = 'BT'
|
|
273
|
+
bv = 'BV'
|
|
274
|
+
bw = 'BW'
|
|
275
|
+
by = 'BY'
|
|
276
|
+
bz = 'BZ'
|
|
277
|
+
ca = 'CA'
|
|
278
|
+
cc = 'CC'
|
|
279
|
+
cd = 'CD'
|
|
280
|
+
cf = 'CF'
|
|
281
|
+
cg = 'CG'
|
|
282
|
+
ch = 'CH'
|
|
283
|
+
ci = 'CI'
|
|
284
|
+
ck = 'CK'
|
|
285
|
+
cl = 'CL'
|
|
286
|
+
cm = 'CM'
|
|
287
|
+
cn = 'CN'
|
|
288
|
+
co = 'CO'
|
|
289
|
+
cr = 'CR'
|
|
290
|
+
cu = 'CU'
|
|
291
|
+
cv = 'CV'
|
|
292
|
+
cw = 'CW'
|
|
293
|
+
cx = 'CX'
|
|
294
|
+
cy = 'CY'
|
|
295
|
+
cz = 'CZ'
|
|
296
|
+
de = 'DE'
|
|
297
|
+
dj = 'DJ'
|
|
298
|
+
dk = 'DK'
|
|
299
|
+
dm = 'DM'
|
|
300
|
+
do = 'DO'
|
|
301
|
+
dz = 'DZ'
|
|
302
|
+
ec = 'EC'
|
|
303
|
+
ee = 'EE'
|
|
304
|
+
eg = 'EG'
|
|
305
|
+
eh = 'EH'
|
|
306
|
+
er = 'ER'
|
|
307
|
+
es = 'ES'
|
|
308
|
+
et = 'ET'
|
|
309
|
+
fi = 'FI'
|
|
310
|
+
fj = 'FJ'
|
|
311
|
+
fk = 'FK'
|
|
312
|
+
fm = 'FM'
|
|
313
|
+
fo = 'FO'
|
|
314
|
+
fr = 'FR'
|
|
315
|
+
ga = 'GA'
|
|
316
|
+
gb = 'GB'
|
|
317
|
+
gd = 'GD'
|
|
318
|
+
ge = 'GE'
|
|
319
|
+
gf = 'GF'
|
|
320
|
+
gg = 'GG'
|
|
321
|
+
gh = 'GH'
|
|
322
|
+
gi = 'GI'
|
|
323
|
+
gl = 'GL'
|
|
324
|
+
gm = 'GM'
|
|
325
|
+
gn = 'GN'
|
|
326
|
+
gp = 'GP'
|
|
327
|
+
gq = 'GQ'
|
|
328
|
+
gr = 'GR'
|
|
329
|
+
gs = 'GS'
|
|
330
|
+
gt = 'GT'
|
|
331
|
+
gu = 'GU'
|
|
332
|
+
gw = 'GW'
|
|
333
|
+
gy = 'GY'
|
|
334
|
+
hk = 'HK'
|
|
335
|
+
hm = 'HM'
|
|
336
|
+
hn = 'HN'
|
|
337
|
+
hr = 'HR'
|
|
338
|
+
ht = 'HT'
|
|
339
|
+
hu = 'HU'
|
|
340
|
+
id = 'ID'
|
|
341
|
+
ie = 'IE'
|
|
342
|
+
il = 'IL'
|
|
343
|
+
im = 'IM'
|
|
344
|
+
in_ = 'IN'
|
|
345
|
+
io = 'IO'
|
|
346
|
+
iq = 'IQ'
|
|
347
|
+
ir = 'IR'
|
|
348
|
+
is_ = 'IS'
|
|
349
|
+
it = 'IT'
|
|
350
|
+
je = 'JE'
|
|
351
|
+
jm = 'JM'
|
|
352
|
+
jo = 'JO'
|
|
353
|
+
jp = 'JP'
|
|
354
|
+
ke = 'KE'
|
|
355
|
+
kg = 'KG'
|
|
356
|
+
kh = 'KH'
|
|
357
|
+
ki = 'KI'
|
|
358
|
+
km = 'KM'
|
|
359
|
+
kn = 'KN'
|
|
360
|
+
kp = 'KP'
|
|
361
|
+
kr = 'KR'
|
|
362
|
+
kw = 'KW'
|
|
363
|
+
ky = 'KY'
|
|
364
|
+
kz = 'KZ'
|
|
365
|
+
la = 'LA'
|
|
366
|
+
lb = 'LB'
|
|
367
|
+
lc = 'LC'
|
|
368
|
+
li = 'LI'
|
|
369
|
+
lk = 'LK'
|
|
370
|
+
lr = 'LR'
|
|
371
|
+
ls = 'LS'
|
|
372
|
+
lt = 'LT'
|
|
373
|
+
lu = 'LU'
|
|
374
|
+
lv = 'LV'
|
|
375
|
+
ly = 'LY'
|
|
376
|
+
ma = 'MA'
|
|
377
|
+
mc = 'MC'
|
|
378
|
+
md = 'MD'
|
|
379
|
+
me = 'ME'
|
|
380
|
+
mf = 'MF'
|
|
381
|
+
mg = 'MG'
|
|
382
|
+
mh = 'MH'
|
|
383
|
+
mk = 'MK'
|
|
384
|
+
ml = 'ML'
|
|
385
|
+
mm = 'MM'
|
|
386
|
+
mn = 'MN'
|
|
387
|
+
mo = 'MO'
|
|
388
|
+
mp = 'MP'
|
|
389
|
+
mq = 'MQ'
|
|
390
|
+
mr = 'MR'
|
|
391
|
+
ms = 'MS'
|
|
392
|
+
mt = 'MT'
|
|
393
|
+
mu = 'MU'
|
|
394
|
+
mv = 'MV'
|
|
395
|
+
mw = 'MW'
|
|
396
|
+
mx = 'MX'
|
|
397
|
+
my = 'MY'
|
|
398
|
+
mz = 'MZ'
|
|
399
|
+
na = 'NA'
|
|
400
|
+
nc = 'NC'
|
|
401
|
+
ne = 'NE'
|
|
402
|
+
nf = 'NF'
|
|
403
|
+
ng = 'NG'
|
|
404
|
+
ni = 'NI'
|
|
405
|
+
nl = 'NL'
|
|
406
|
+
no = 'NO'
|
|
407
|
+
np = 'NP'
|
|
408
|
+
nr = 'NR'
|
|
409
|
+
nu = 'NU'
|
|
410
|
+
nz = 'NZ'
|
|
411
|
+
om = 'OM'
|
|
412
|
+
pa = 'PA'
|
|
413
|
+
pe = 'PE'
|
|
414
|
+
pf = 'PF'
|
|
415
|
+
pg = 'PG'
|
|
416
|
+
ph = 'PH'
|
|
417
|
+
pk = 'PK'
|
|
418
|
+
pl = 'PL'
|
|
419
|
+
pm = 'PM'
|
|
420
|
+
pn = 'PN'
|
|
421
|
+
pr = 'PR'
|
|
422
|
+
ps = 'PS'
|
|
423
|
+
pt = 'PT'
|
|
424
|
+
pw = 'PW'
|
|
425
|
+
py = 'PY'
|
|
426
|
+
qa = 'QA'
|
|
427
|
+
re = 'RE'
|
|
428
|
+
ro = 'RO'
|
|
429
|
+
rs = 'RS'
|
|
430
|
+
ru = 'RU'
|
|
431
|
+
rw = 'RW'
|
|
432
|
+
sa = 'SA'
|
|
433
|
+
sb = 'SB'
|
|
434
|
+
sc = 'SC'
|
|
435
|
+
sd = 'SD'
|
|
436
|
+
se = 'SE'
|
|
437
|
+
sg = 'SG'
|
|
438
|
+
sh = 'SH'
|
|
439
|
+
si = 'SI'
|
|
440
|
+
sj = 'SJ'
|
|
441
|
+
sk = 'SK'
|
|
442
|
+
sl = 'SL'
|
|
443
|
+
sm = 'SM'
|
|
444
|
+
sn = 'SN'
|
|
445
|
+
so = 'SO'
|
|
446
|
+
sr = 'SR'
|
|
447
|
+
st = 'ST'
|
|
448
|
+
sv = 'SV'
|
|
449
|
+
sx = 'SX'
|
|
450
|
+
sy = 'SY'
|
|
451
|
+
sz = 'SZ'
|
|
452
|
+
tc = 'TC'
|
|
453
|
+
td = 'TD'
|
|
454
|
+
tf = 'TF'
|
|
455
|
+
tg = 'TG'
|
|
456
|
+
th = 'TH'
|
|
457
|
+
tj = 'TJ'
|
|
458
|
+
tk = 'TK'
|
|
459
|
+
tl = 'TL'
|
|
460
|
+
tm = 'TM'
|
|
461
|
+
tn = 'TN'
|
|
462
|
+
to = 'TO'
|
|
463
|
+
tr = 'TR'
|
|
464
|
+
tt = 'TT'
|
|
465
|
+
tv = 'TV'
|
|
466
|
+
tw = 'TW'
|
|
467
|
+
tz = 'TZ'
|
|
468
|
+
ua = 'UA'
|
|
469
|
+
ug = 'UG'
|
|
470
|
+
um = 'UM'
|
|
471
|
+
us = 'US'
|
|
472
|
+
uy = 'UY'
|
|
473
|
+
uz = 'UZ'
|
|
474
|
+
va = 'VA'
|
|
475
|
+
vc = 'VC'
|
|
476
|
+
ve = 'VE'
|
|
477
|
+
vg = 'VG'
|
|
478
|
+
vi = 'VI'
|
|
479
|
+
vn = 'VN'
|
|
480
|
+
vu = 'VU'
|
|
481
|
+
wf = 'WF'
|
|
482
|
+
ws = 'WS'
|
|
483
|
+
ye = 'YE'
|
|
484
|
+
yt = 'YT'
|
|
485
|
+
za = 'ZA'
|
|
486
|
+
zm = 'ZM'
|
|
487
|
+
zw = 'ZW'
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
class CouponConstraint(EbayModel):
|
|
491
|
+
expiration_date: str | None = Field(
|
|
492
|
+
None,
|
|
493
|
+
alias='expirationDate',
|
|
494
|
+
description='This timestamp provides the expiration date of the coded coupon.',
|
|
495
|
+
)
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
class CouponDiscountType(OpenStrEnum):
|
|
499
|
+
item_price = 'ITEM_PRICE'
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
class CurrencyCodeEnum(OpenStrEnum):
|
|
503
|
+
aed = 'AED'
|
|
504
|
+
afn = 'AFN'
|
|
505
|
+
all = 'ALL'
|
|
506
|
+
amd = 'AMD'
|
|
507
|
+
ang = 'ANG'
|
|
508
|
+
aoa = 'AOA'
|
|
509
|
+
ars = 'ARS'
|
|
510
|
+
aud = 'AUD'
|
|
511
|
+
awg = 'AWG'
|
|
512
|
+
azn = 'AZN'
|
|
513
|
+
bam = 'BAM'
|
|
514
|
+
bbd = 'BBD'
|
|
515
|
+
bdt = 'BDT'
|
|
516
|
+
bgn = 'BGN'
|
|
517
|
+
bhd = 'BHD'
|
|
518
|
+
bif = 'BIF'
|
|
519
|
+
bmd = 'BMD'
|
|
520
|
+
bnd = 'BND'
|
|
521
|
+
bob = 'BOB'
|
|
522
|
+
brl = 'BRL'
|
|
523
|
+
bsd = 'BSD'
|
|
524
|
+
btn = 'BTN'
|
|
525
|
+
bwp = 'BWP'
|
|
526
|
+
byr = 'BYR'
|
|
527
|
+
bzd = 'BZD'
|
|
528
|
+
cad = 'CAD'
|
|
529
|
+
cdf = 'CDF'
|
|
530
|
+
chf = 'CHF'
|
|
531
|
+
clp = 'CLP'
|
|
532
|
+
cny = 'CNY'
|
|
533
|
+
cop = 'COP'
|
|
534
|
+
crc = 'CRC'
|
|
535
|
+
cup = 'CUP'
|
|
536
|
+
cve = 'CVE'
|
|
537
|
+
czk = 'CZK'
|
|
538
|
+
djf = 'DJF'
|
|
539
|
+
dkk = 'DKK'
|
|
540
|
+
dop = 'DOP'
|
|
541
|
+
dzd = 'DZD'
|
|
542
|
+
egp = 'EGP'
|
|
543
|
+
ern = 'ERN'
|
|
544
|
+
etb = 'ETB'
|
|
545
|
+
eur = 'EUR'
|
|
546
|
+
fjd = 'FJD'
|
|
547
|
+
fkp = 'FKP'
|
|
548
|
+
gbp = 'GBP'
|
|
549
|
+
gel = 'GEL'
|
|
550
|
+
ghs = 'GHS'
|
|
551
|
+
gip = 'GIP'
|
|
552
|
+
gmd = 'GMD'
|
|
553
|
+
gnf = 'GNF'
|
|
554
|
+
gtq = 'GTQ'
|
|
555
|
+
gyd = 'GYD'
|
|
556
|
+
hkd = 'HKD'
|
|
557
|
+
hnl = 'HNL'
|
|
558
|
+
hrk = 'HRK'
|
|
559
|
+
htg = 'HTG'
|
|
560
|
+
huf = 'HUF'
|
|
561
|
+
idr = 'IDR'
|
|
562
|
+
ils = 'ILS'
|
|
563
|
+
inr = 'INR'
|
|
564
|
+
iqd = 'IQD'
|
|
565
|
+
irr = 'IRR'
|
|
566
|
+
isk = 'ISK'
|
|
567
|
+
jmd = 'JMD'
|
|
568
|
+
jod = 'JOD'
|
|
569
|
+
jpy = 'JPY'
|
|
570
|
+
kes = 'KES'
|
|
571
|
+
kgs = 'KGS'
|
|
572
|
+
khr = 'KHR'
|
|
573
|
+
kmf = 'KMF'
|
|
574
|
+
kpw = 'KPW'
|
|
575
|
+
krw = 'KRW'
|
|
576
|
+
kwd = 'KWD'
|
|
577
|
+
kyd = 'KYD'
|
|
578
|
+
kzt = 'KZT'
|
|
579
|
+
lak = 'LAK'
|
|
580
|
+
lbp = 'LBP'
|
|
581
|
+
lkr = 'LKR'
|
|
582
|
+
lrd = 'LRD'
|
|
583
|
+
lsl = 'LSL'
|
|
584
|
+
ltl = 'LTL'
|
|
585
|
+
lyd = 'LYD'
|
|
586
|
+
mad = 'MAD'
|
|
587
|
+
mdl = 'MDL'
|
|
588
|
+
mga = 'MGA'
|
|
589
|
+
mkd = 'MKD'
|
|
590
|
+
mmk = 'MMK'
|
|
591
|
+
mnt = 'MNT'
|
|
592
|
+
mop = 'MOP'
|
|
593
|
+
mro_1 = 'MRO'
|
|
594
|
+
mur = 'MUR'
|
|
595
|
+
mvr = 'MVR'
|
|
596
|
+
mwk = 'MWK'
|
|
597
|
+
mxn = 'MXN'
|
|
598
|
+
myr = 'MYR'
|
|
599
|
+
mzn = 'MZN'
|
|
600
|
+
nad = 'NAD'
|
|
601
|
+
ngn = 'NGN'
|
|
602
|
+
nio = 'NIO'
|
|
603
|
+
nok = 'NOK'
|
|
604
|
+
npr = 'NPR'
|
|
605
|
+
nzd = 'NZD'
|
|
606
|
+
omr = 'OMR'
|
|
607
|
+
pab = 'PAB'
|
|
608
|
+
pen = 'PEN'
|
|
609
|
+
pgk = 'PGK'
|
|
610
|
+
php = 'PHP'
|
|
611
|
+
pkr = 'PKR'
|
|
612
|
+
pln = 'PLN'
|
|
613
|
+
pyg = 'PYG'
|
|
614
|
+
qar = 'QAR'
|
|
615
|
+
ron = 'RON'
|
|
616
|
+
rsd = 'RSD'
|
|
617
|
+
rub = 'RUB'
|
|
618
|
+
rwf = 'RWF'
|
|
619
|
+
sar = 'SAR'
|
|
620
|
+
sbd = 'SBD'
|
|
621
|
+
scr = 'SCR'
|
|
622
|
+
sdg = 'SDG'
|
|
623
|
+
sek = 'SEK'
|
|
624
|
+
sgd = 'SGD'
|
|
625
|
+
shp = 'SHP'
|
|
626
|
+
sll = 'SLL'
|
|
627
|
+
sos = 'SOS'
|
|
628
|
+
srd = 'SRD'
|
|
629
|
+
std = 'STD'
|
|
630
|
+
syp = 'SYP'
|
|
631
|
+
szl = 'SZL'
|
|
632
|
+
thb = 'THB'
|
|
633
|
+
tjs = 'TJS'
|
|
634
|
+
tmt = 'TMT'
|
|
635
|
+
tnd = 'TND'
|
|
636
|
+
top = 'TOP'
|
|
637
|
+
try_ = 'TRY'
|
|
638
|
+
ttd = 'TTD'
|
|
639
|
+
twd = 'TWD'
|
|
640
|
+
tzs = 'TZS'
|
|
641
|
+
uah = 'UAH'
|
|
642
|
+
ugx = 'UGX'
|
|
643
|
+
usd = 'USD'
|
|
644
|
+
uyu = 'UYU'
|
|
645
|
+
uzs = 'UZS'
|
|
646
|
+
vef = 'VEF'
|
|
647
|
+
vnd = 'VND'
|
|
648
|
+
vuv = 'VUV'
|
|
649
|
+
wst = 'WST'
|
|
650
|
+
xaf = 'XAF'
|
|
651
|
+
xcd = 'XCD'
|
|
652
|
+
xof = 'XOF'
|
|
653
|
+
xpf = 'XPF'
|
|
654
|
+
yer = 'YER'
|
|
655
|
+
zar = 'ZAR'
|
|
656
|
+
zmw = 'ZMW'
|
|
657
|
+
zwl = 'ZWL'
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
class DeliveryOptionsEnum(OpenStrEnum):
|
|
661
|
+
ship_to_home = 'SHIP_TO_HOME'
|
|
662
|
+
seller_arranged_local_pickup = 'SELLER_ARRANGED_LOCAL_PICKUP'
|
|
663
|
+
in_store_pickup = 'IN_STORE_PICKUP'
|
|
664
|
+
pickup_drop_off = 'PICKUP_DROP_OFF'
|
|
665
|
+
digital_delivery = 'DIGITAL_DELIVERY'
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
class EconomicOperator(EbayModel):
|
|
669
|
+
company_name: str | None = Field(
|
|
670
|
+
None,
|
|
671
|
+
alias='companyName',
|
|
672
|
+
description='The company name of the registered Economic Operator.',
|
|
673
|
+
)
|
|
674
|
+
address_line1: str | None = Field(
|
|
675
|
+
None,
|
|
676
|
+
alias='addressLine1',
|
|
677
|
+
description="The first line of the registered Economic Operator's street address.",
|
|
678
|
+
)
|
|
679
|
+
address_line2: str | None = Field(
|
|
680
|
+
None,
|
|
681
|
+
alias='addressLine2',
|
|
682
|
+
description="The second line, if any, of the registered Economic Operator's street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.",
|
|
683
|
+
)
|
|
684
|
+
city: str | None = Field(
|
|
685
|
+
None,
|
|
686
|
+
description="The city of the registered Economic Operator's street address.",
|
|
687
|
+
)
|
|
688
|
+
state_or_province: str | None = Field(
|
|
689
|
+
None,
|
|
690
|
+
alias='stateOrProvince',
|
|
691
|
+
description="The state or province of the registered Economic Operator's street address.",
|
|
692
|
+
)
|
|
693
|
+
postal_code: str | None = Field(
|
|
694
|
+
None,
|
|
695
|
+
alias='postalCode',
|
|
696
|
+
description="The postal code of the registered Economic Operator's street address.",
|
|
697
|
+
)
|
|
698
|
+
country: str | None = Field(
|
|
699
|
+
None,
|
|
700
|
+
description="The two-letter ISO 3166 standard abbreviation of the country of the registered Economic Operator's address.",
|
|
701
|
+
)
|
|
702
|
+
phone: str | None = Field(
|
|
703
|
+
None, description="The registered Economic Operator's business phone number."
|
|
704
|
+
)
|
|
705
|
+
email: str | None = Field(
|
|
706
|
+
None, description="The registered Economic Operator's business email address."
|
|
707
|
+
)
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
class ErrorParameter(EbayModel):
|
|
711
|
+
name: str | None = Field(None, description='The object of the error.')
|
|
712
|
+
value: str | None = Field(None, description='The value of the object.')
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
class ErrorParameterV3(EbayModel):
|
|
716
|
+
name: str | None = Field(
|
|
717
|
+
None,
|
|
718
|
+
description='This is the name of input field that caused an issue with the call request.',
|
|
719
|
+
)
|
|
720
|
+
value: str | None = Field(
|
|
721
|
+
None,
|
|
722
|
+
description='This is the actual value that was passed in for the element specified in the name field.',
|
|
723
|
+
)
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
class EstimatedAvailability(EbayModel):
|
|
727
|
+
availability_threshold: int | None = Field(
|
|
728
|
+
None,
|
|
729
|
+
alias='availabilityThreshold',
|
|
730
|
+
description='This field is return only when the seller sets their \' display item quantity \' preference to Display "More than 10 available" in your listing (if applicable) . The value of this field will be "10", which is the threshold value. Code so that your app gracefully handles any future changes to this value.',
|
|
731
|
+
)
|
|
732
|
+
availability_threshold_type: AvailabilityThresholdEnum | None = Field(
|
|
733
|
+
None,
|
|
734
|
+
alias='availabilityThresholdType',
|
|
735
|
+
description='This field is return only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicable) . The value of this field will be MORE_THAN . This indicates that the seller has more than the \'quantity display preference\', which is 10, in stock for this item. The following are the display item quantity preferences the seller can set.',
|
|
736
|
+
)
|
|
737
|
+
delivery_options: list[DeliveryOptionsEnum] | None = Field(
|
|
738
|
+
None,
|
|
739
|
+
alias='deliveryOptions',
|
|
740
|
+
description='An array of available delivery options. Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY Code so that your app gracefully handles any future changes to this list.',
|
|
741
|
+
)
|
|
742
|
+
estimated_availability_status: AvailabilityStatusEnum | None = Field(
|
|
743
|
+
None,
|
|
744
|
+
alias='estimatedAvailabilityStatus',
|
|
745
|
+
description='An enumeration value representing the inventory status of this item. Note: Be sure to review the itemEndDate field to determine whether the item is available for purchase. Valid Values: IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK Code so that your app gracefully handles any future changes to this list.',
|
|
746
|
+
)
|
|
747
|
+
estimated_available_quantity: int | None = Field(
|
|
748
|
+
None,
|
|
749
|
+
alias='estimatedAvailableQuantity',
|
|
750
|
+
description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. Note: To see if a listing is available for purchase, review the itemEndDate and estimatedAvailablityStatus fields.',
|
|
751
|
+
)
|
|
752
|
+
estimated_remaining_quantity: int | None = Field(
|
|
753
|
+
None,
|
|
754
|
+
alias='estimatedRemainingQuantity',
|
|
755
|
+
description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. Note: To see if a listing is available for purchase, review the itemEndDate and estimatedAvailablityStatus fields.',
|
|
756
|
+
)
|
|
757
|
+
estimated_sold_quantity: int | None = Field(
|
|
758
|
+
None,
|
|
759
|
+
alias='estimatedSoldQuantity',
|
|
760
|
+
description='The estimated number of this item that have been sold.',
|
|
761
|
+
)
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
class FulfilledThroughEnum(OpenStrEnum):
|
|
765
|
+
global_shipping = 'GLOBAL_SHIPPING'
|
|
766
|
+
international_shipping = 'INTERNATIONAL_SHIPPING'
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
class HazardPictogram(EbayModel):
|
|
770
|
+
pictogram_description: str | None = Field(
|
|
771
|
+
None,
|
|
772
|
+
alias='pictogramDescription',
|
|
773
|
+
description='The description of the hazard pictogram, such as Flammable.',
|
|
774
|
+
)
|
|
775
|
+
pictogram_id: str | None = Field(
|
|
776
|
+
None, alias='pictogramId', description='The ID of the hazard pictogram.'
|
|
777
|
+
)
|
|
778
|
+
pictogram_url: str | None = Field(
|
|
779
|
+
None, alias='pictogramUrl', description='The URL of the hazard pictogram.'
|
|
780
|
+
)
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
class HazardStatement(EbayModel):
|
|
784
|
+
statement_description: str | None = Field(
|
|
785
|
+
None,
|
|
786
|
+
alias='statementDescription',
|
|
787
|
+
description='A description of the nature of the hazard, such as whether the material is toxic if swallowed.',
|
|
788
|
+
)
|
|
789
|
+
statement_id: str | None = Field(
|
|
790
|
+
None, alias='statementId', description='The ID of the hazard statement.'
|
|
791
|
+
)
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
class HazardousMaterialsLabels(EbayModel):
|
|
795
|
+
additional_information: str | None = Field(
|
|
796
|
+
None,
|
|
797
|
+
alias='additionalInformation',
|
|
798
|
+
description='Additional information about the hazardous materials labels.',
|
|
799
|
+
)
|
|
800
|
+
pictograms: list[HazardPictogram] | None = Field(
|
|
801
|
+
None, description='An array of hazard pictograms that apply to the item.'
|
|
802
|
+
)
|
|
803
|
+
signal_word: str | None = Field(
|
|
804
|
+
None,
|
|
805
|
+
alias='signalWord',
|
|
806
|
+
description='The signal word for the hazardous materials label (such as Danger or Warning).',
|
|
807
|
+
)
|
|
808
|
+
signal_word_id: str | None = Field(
|
|
809
|
+
None,
|
|
810
|
+
alias='signalWordId',
|
|
811
|
+
description='The ID of the signal word for the hazardous materials label.',
|
|
812
|
+
)
|
|
813
|
+
statements: list[HazardStatement] | None = Field(
|
|
814
|
+
None, description='An array of hazard statements for the item.'
|
|
815
|
+
)
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
class Image(EbayModel):
|
|
819
|
+
height: int | None = Field(None, description='Reserved for future use.')
|
|
820
|
+
image_url: str | None = Field(
|
|
821
|
+
None, alias='imageUrl', description='The URL of the image.'
|
|
822
|
+
)
|
|
823
|
+
width: int | None = Field(None, description='Reserved for future use.')
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
class ItemCharityTerms(EbayModel):
|
|
827
|
+
charity_org_id: str | None = Field(
|
|
828
|
+
None,
|
|
829
|
+
alias='charityOrgId',
|
|
830
|
+
description='The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds from the item.',
|
|
831
|
+
)
|
|
832
|
+
donation_percentage: float | None = Field(
|
|
833
|
+
None,
|
|
834
|
+
alias='donationPercentage',
|
|
835
|
+
description='The percentage of the purchase price of the item that the charitable organization (identified in the charityOrgId field) will receive for each sale.',
|
|
836
|
+
)
|
|
837
|
+
logo_image: Image | None = Field(
|
|
838
|
+
None,
|
|
839
|
+
alias='LogoImage',
|
|
840
|
+
description="The details of the charity's logo image, such as the size and URL. Note: Currently, only the imageUrl is populated.",
|
|
841
|
+
)
|
|
842
|
+
name: str | None = Field(None, description='The name of the charity organization.')
|
|
843
|
+
website: str | None = Field(None, description="The URL to the charity's eBay page.")
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
class ItemGroupTypeEnum(OpenStrEnum):
|
|
847
|
+
seller_defined_variations = 'SELLER_DEFINED_VARIATIONS'
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
class ItemLocationImpl(EbayModel):
|
|
851
|
+
address_line1: str | None = Field(
|
|
852
|
+
None, alias='addressLine1', description='The first line of the street address.'
|
|
853
|
+
)
|
|
854
|
+
address_line2: str | None = Field(
|
|
855
|
+
None,
|
|
856
|
+
alias='addressLine2',
|
|
857
|
+
description='The second line of the street address. This field may contain such values as an apartment or suite number.',
|
|
858
|
+
)
|
|
859
|
+
city: str | None = Field(
|
|
860
|
+
None,
|
|
861
|
+
description='The city in which the item is located. Restriction: This field is populated in the search method response only when fieldgroups = EXTENDED .',
|
|
862
|
+
)
|
|
863
|
+
country: CountryCodeEnum | None = Field(
|
|
864
|
+
None,
|
|
865
|
+
description='The two-letter ISO 3166 standard code that indicates the country in which the item is located.',
|
|
866
|
+
)
|
|
867
|
+
county: str | None = Field(
|
|
868
|
+
None, description='The county in which the item is located.'
|
|
869
|
+
)
|
|
870
|
+
postal_code: str | None = Field(
|
|
871
|
+
None,
|
|
872
|
+
alias='postalCode',
|
|
873
|
+
description='The postal code (or zip code in US) where the item is located. Sellers set a postal code for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API.',
|
|
874
|
+
)
|
|
875
|
+
state_or_province: str | None = Field(
|
|
876
|
+
None,
|
|
877
|
+
alias='stateOrProvince',
|
|
878
|
+
description='The state or province in which the item is located.',
|
|
879
|
+
)
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
class LegalAddress(EbayModel):
|
|
883
|
+
address_line1: str | None = Field(
|
|
884
|
+
None, alias='addressLine1', description='The first line of the street address.'
|
|
885
|
+
)
|
|
886
|
+
address_line2: str | None = Field(
|
|
887
|
+
None,
|
|
888
|
+
alias='addressLine2',
|
|
889
|
+
description="The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.",
|
|
890
|
+
)
|
|
891
|
+
city: str | None = Field(None, description='The city of the address.')
|
|
892
|
+
country: CountryCodeEnum | None = Field(
|
|
893
|
+
None,
|
|
894
|
+
description='The two-letter ISO 3166 standard code for the country of the address.',
|
|
895
|
+
)
|
|
896
|
+
country_name: str | None = Field(
|
|
897
|
+
None, alias='countryName', description='The name of the country of the address.'
|
|
898
|
+
)
|
|
899
|
+
county: str | None = Field(
|
|
900
|
+
None, description='The name of the county of the address.'
|
|
901
|
+
)
|
|
902
|
+
postal_code: str | None = Field(
|
|
903
|
+
None, alias='postalCode', description='The postal code of the address.'
|
|
904
|
+
)
|
|
905
|
+
state_or_province: str | None = Field(
|
|
906
|
+
None,
|
|
907
|
+
alias='stateOrProvince',
|
|
908
|
+
description='The state or province of the address.',
|
|
909
|
+
)
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
class MarketplaceIdEnum(OpenStrEnum):
|
|
913
|
+
ebay_au = 'EBAY_AU'
|
|
914
|
+
ebay_at = 'EBAY_AT'
|
|
915
|
+
ebay_be = 'EBAY_BE'
|
|
916
|
+
ebay_ca = 'EBAY_CA'
|
|
917
|
+
ebay_ch = 'EBAY_CH'
|
|
918
|
+
ebay_cn = 'EBAY_CN'
|
|
919
|
+
ebay_cz = 'EBAY_CZ'
|
|
920
|
+
ebay_de = 'EBAY_DE'
|
|
921
|
+
ebay_dk = 'EBAY_DK'
|
|
922
|
+
ebay_es = 'EBAY_ES'
|
|
923
|
+
ebay_fi = 'EBAY_FI'
|
|
924
|
+
ebay_fr = 'EBAY_FR'
|
|
925
|
+
ebay_gb = 'EBAY_GB'
|
|
926
|
+
ebay_gr = 'EBAY_GR'
|
|
927
|
+
ebay_half_us = 'EBAY_HALF_US'
|
|
928
|
+
ebay_hk = 'EBAY_HK'
|
|
929
|
+
ebay_hu = 'EBAY_HU'
|
|
930
|
+
ebay_id = 'EBAY_ID'
|
|
931
|
+
ebay_ie = 'EBAY_IE'
|
|
932
|
+
ebay_il = 'EBAY_IL'
|
|
933
|
+
ebay_in = 'EBAY_IN'
|
|
934
|
+
ebay_it = 'EBAY_IT'
|
|
935
|
+
ebay_jp = 'EBAY_JP'
|
|
936
|
+
ebay_motors_us = 'EBAY_MOTORS_US'
|
|
937
|
+
ebay_my = 'EBAY_MY'
|
|
938
|
+
ebay_nl = 'EBAY_NL'
|
|
939
|
+
ebay_no = 'EBAY_NO'
|
|
940
|
+
ebay_nz = 'EBAY_NZ'
|
|
941
|
+
ebay_pe = 'EBAY_PE'
|
|
942
|
+
ebay_ph = 'EBAY_PH'
|
|
943
|
+
ebay_pl = 'EBAY_PL'
|
|
944
|
+
ebay_pr = 'EBAY_PR'
|
|
945
|
+
ebay_pt = 'EBAY_PT'
|
|
946
|
+
ebay_ru = 'EBAY_RU'
|
|
947
|
+
ebay_se = 'EBAY_SE'
|
|
948
|
+
ebay_sg = 'EBAY_SG'
|
|
949
|
+
ebay_th = 'EBAY_TH'
|
|
950
|
+
ebay_tw = 'EBAY_TW'
|
|
951
|
+
ebay_us = 'EBAY_US'
|
|
952
|
+
ebay_vn = 'EBAY_VN'
|
|
953
|
+
ebay_za = 'EBAY_ZA'
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
class PaymentInstructionEnum(OpenStrEnum):
|
|
957
|
+
direct_debit = 'DIRECT_DEBIT'
|
|
958
|
+
ach = 'ACH'
|
|
959
|
+
eft = 'EFT'
|
|
960
|
+
cip = 'CIP'
|
|
961
|
+
money_transfer = 'MONEY_TRANSFER'
|
|
962
|
+
cash_in_person = 'CASH_IN_PERSON'
|
|
963
|
+
cash_on_pickup = 'CASH_ON_PICKUP'
|
|
964
|
+
cash_on_delivery = 'CASH_ON_DELIVERY'
|
|
965
|
+
contact_seller = 'CONTACT_SELLER'
|
|
966
|
+
pay_upon_invoice = 'PAY_UPON_INVOICE'
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
class PaymentMethodBrandEnum(OpenStrEnum):
|
|
970
|
+
visa = 'VISA'
|
|
971
|
+
mastercard = 'MASTERCARD'
|
|
972
|
+
discover = 'DISCOVER'
|
|
973
|
+
american_express = 'AMERICAN_EXPRESS'
|
|
974
|
+
cb_nationale = 'CB_NATIONALE'
|
|
975
|
+
cetelem = 'CETELEM'
|
|
976
|
+
cofidis = 'COFIDIS'
|
|
977
|
+
cofinoga = 'COFINOGA'
|
|
978
|
+
maestro = 'MAESTRO'
|
|
979
|
+
switch = 'SWITCH'
|
|
980
|
+
postepay = 'POSTEPAY'
|
|
981
|
+
cb = 'CB'
|
|
982
|
+
diners_club = 'DINERS_CLUB'
|
|
983
|
+
union_pay = 'UNION_PAY'
|
|
984
|
+
paypal_credit = 'PAYPAL_CREDIT'
|
|
985
|
+
paypal = 'PAYPAL'
|
|
986
|
+
google_pay = 'GOOGLE_PAY'
|
|
987
|
+
apple_pay = 'APPLE_PAY'
|
|
988
|
+
qiwi = 'QIWI'
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
class PaymentMethodTypeEnum(OpenStrEnum):
|
|
992
|
+
credit_card = 'CREDIT_CARD'
|
|
993
|
+
wallet = 'WALLET'
|
|
994
|
+
debit_card = 'DEBIT_CARD'
|
|
995
|
+
credit = 'CREDIT'
|
|
996
|
+
bank = 'BANK'
|
|
997
|
+
cash = 'CASH'
|
|
998
|
+
other = 'OTHER'
|
|
999
|
+
check = 'CHECK'
|
|
1000
|
+
money_order = 'MONEY_ORDER'
|
|
1001
|
+
wire_transfer = 'WIRE_TRANSFER'
|
|
1002
|
+
deferred = 'DEFERRED'
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
class PickupOptionSummary(EbayModel):
|
|
1006
|
+
pickup_location_type: str | None = Field(
|
|
1007
|
+
None,
|
|
1008
|
+
alias='pickupLocationType',
|
|
1009
|
+
description='This container returns the local pickup options available to the buyer. Possible values are ARRANGED_LOCATION and STORE .',
|
|
1010
|
+
)
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
class PriceDisplayConditionEnum(OpenStrEnum):
|
|
1014
|
+
only_show_when_added_in_cart = 'ONLY_SHOW_WHEN_ADDED_IN_CART'
|
|
1015
|
+
only_show_on_request = 'ONLY_SHOW_ON_REQUEST'
|
|
1016
|
+
always_show = 'ALWAYS_SHOW'
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
class PriceTreatmentEnum(OpenStrEnum):
|
|
1020
|
+
minimum_advertised_price = 'MINIMUM_ADVERTISED_PRICE'
|
|
1021
|
+
list_price = 'LIST_PRICE'
|
|
1022
|
+
markdown = 'MARKDOWN'
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
class ProductIdentity(EbayModel):
|
|
1026
|
+
identifier_type: str | None = Field(
|
|
1027
|
+
None,
|
|
1028
|
+
alias='identifierType',
|
|
1029
|
+
description='The type of product identifier, such as UPC and EAN.',
|
|
1030
|
+
)
|
|
1031
|
+
identifier_value: str | None = Field(
|
|
1032
|
+
None, alias='identifierValue', description='The product identifier value.'
|
|
1033
|
+
)
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
class ProductSafetyLabelPictogram(EbayModel):
|
|
1037
|
+
pictogram_description: str | None = Field(
|
|
1038
|
+
None,
|
|
1039
|
+
alias='pictogramDescription',
|
|
1040
|
+
description='The description of the safety label pictogram.',
|
|
1041
|
+
)
|
|
1042
|
+
pictogram_id: str | None = Field(
|
|
1043
|
+
None,
|
|
1044
|
+
alias='pictogramId',
|
|
1045
|
+
description='The identifier of the safety label pictogram.',
|
|
1046
|
+
)
|
|
1047
|
+
pictogram_url: str | None = Field(
|
|
1048
|
+
None, alias='pictogramUrl', description='The URL of the safety label pictogram.'
|
|
1049
|
+
)
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
class ProductSafetyLabelStatement(EbayModel):
|
|
1053
|
+
statement_description: str | None = Field(
|
|
1054
|
+
None,
|
|
1055
|
+
alias='statementDescription',
|
|
1056
|
+
description='A description of the nature of the product safety label statement.',
|
|
1057
|
+
)
|
|
1058
|
+
statement_id: str | None = Field(
|
|
1059
|
+
None,
|
|
1060
|
+
alias='statementId',
|
|
1061
|
+
description='The identifier of the product safety label statement.',
|
|
1062
|
+
)
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
class ProductSafetyLabels(EbayModel):
|
|
1066
|
+
pictograms: list[ProductSafetyLabelPictogram] | None = Field(
|
|
1067
|
+
None,
|
|
1068
|
+
description='An array of seller provided comma-separated string values that provides identifier, URL, and description for one or more pictograms associated with the listing.',
|
|
1069
|
+
)
|
|
1070
|
+
statements: list[ProductSafetyLabelStatement] | None = Field(
|
|
1071
|
+
None,
|
|
1072
|
+
description='An array of seller provided comma-separated string values that provide identifier and description for one or more product safety statements associated with the listing.',
|
|
1073
|
+
)
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
class RangeValue(EbayModel):
|
|
1077
|
+
end: str | None = Field(
|
|
1078
|
+
None,
|
|
1079
|
+
description='Specifies the end or upper limit of the range. This can be empty which equates to greater than or equal to the start or lower limit.',
|
|
1080
|
+
)
|
|
1081
|
+
exclusive_end: bool | None = Field(
|
|
1082
|
+
None,
|
|
1083
|
+
alias='exclusiveEnd',
|
|
1084
|
+
description='Specifies whether the end value is to be included in the range. For example, if end is 100 , and exclusiveEnd is true , the end range would be <100. But if it is set to false , it is <=100.',
|
|
1085
|
+
)
|
|
1086
|
+
exclusive_start: bool | None = Field(
|
|
1087
|
+
None,
|
|
1088
|
+
alias='exclusiveStart',
|
|
1089
|
+
description='Specifies whether the start value is to be included in the range. For example, if start is 60 , and exclusiveStart is true , the start range would be >60. But if it is set to false , it is >=60.',
|
|
1090
|
+
)
|
|
1091
|
+
range: bool | None = Field(
|
|
1092
|
+
None, description='Specifies whether the filter is for a range of values.'
|
|
1093
|
+
)
|
|
1094
|
+
start: str | None = Field(
|
|
1095
|
+
None,
|
|
1096
|
+
description='Specifies the start or lower limit of the range. This can be empty which equates to lesser than or equal to the end or upper limit.',
|
|
1097
|
+
)
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
class RatingHistogram(EbayModel):
|
|
1101
|
+
count: int | None = Field(
|
|
1102
|
+
None,
|
|
1103
|
+
description='The total number of user ratings that the product has received.',
|
|
1104
|
+
)
|
|
1105
|
+
rating: str | None = Field(
|
|
1106
|
+
None,
|
|
1107
|
+
description='This is the average rating for the product. As part of a product review, users rate the product. Products are rated from one star (terrible) to five stars (excellent), with each star having a corresponding point value - one star gets 1 point, two stars get 2 points, and so on.',
|
|
1108
|
+
)
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
class RefundMethodEnum(OpenStrEnum):
|
|
1112
|
+
money_back = 'MONEY_BACK'
|
|
1113
|
+
merchandise_credit = 'MERCHANDISE_CREDIT'
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
class RegionTypeEnum(OpenStrEnum):
|
|
1117
|
+
country_region = 'COUNTRY_REGION'
|
|
1118
|
+
state_or_province = 'STATE_OR_PROVINCE'
|
|
1119
|
+
country = 'COUNTRY'
|
|
1120
|
+
world_region = 'WORLD_REGION'
|
|
1121
|
+
worldwide = 'WORLDWIDE'
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
class ResponsiblePersonTypeEnum(OpenStrEnum):
|
|
1125
|
+
eu_responsible_person = 'EU_RESPONSIBLE_PERSON'
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
class ReturnMethodEnum(OpenStrEnum):
|
|
1129
|
+
replacement = 'REPLACEMENT'
|
|
1130
|
+
exchange = 'EXCHANGE'
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
class ReturnShippingCostPayerEnum(OpenStrEnum):
|
|
1134
|
+
seller = 'SELLER'
|
|
1135
|
+
buyer = 'BUYER'
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
class ReviewRating(EbayModel):
|
|
1139
|
+
average_rating: str | None = Field(
|
|
1140
|
+
None,
|
|
1141
|
+
alias='averageRating',
|
|
1142
|
+
description='The average rating given to a product based on customer reviews.',
|
|
1143
|
+
)
|
|
1144
|
+
rating_histograms: list[RatingHistogram] | None = Field(
|
|
1145
|
+
None,
|
|
1146
|
+
alias='ratingHistograms',
|
|
1147
|
+
description='An array of containers for the product rating histograms that shows the review counts and the product rating.',
|
|
1148
|
+
)
|
|
1149
|
+
review_count: int | None = Field(
|
|
1150
|
+
None,
|
|
1151
|
+
alias='reviewCount',
|
|
1152
|
+
description='The total number of reviews for the item.',
|
|
1153
|
+
)
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
class SearchByImageRequest(EbayModel):
|
|
1157
|
+
image: str | None = Field(
|
|
1158
|
+
None,
|
|
1159
|
+
description='The Base64 string of the image. To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter .',
|
|
1160
|
+
)
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
class Seller(EbayModel):
|
|
1164
|
+
feedback_percentage: str | None = Field(
|
|
1165
|
+
None,
|
|
1166
|
+
alias='feedbackPercentage',
|
|
1167
|
+
description='The percentage of the total positive feedback.',
|
|
1168
|
+
)
|
|
1169
|
+
feedback_score: int | None = Field(
|
|
1170
|
+
None,
|
|
1171
|
+
alias='feedbackScore',
|
|
1172
|
+
description='The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.',
|
|
1173
|
+
)
|
|
1174
|
+
seller_account_type: str | None = Field(
|
|
1175
|
+
None,
|
|
1176
|
+
alias='sellerAccountType',
|
|
1177
|
+
description='Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay: If they register for a business account, this value will be BUSINESS . If they register for a private account, this value will be INDIVIDUAL . This designation is required by the tax laws in some countries.',
|
|
1178
|
+
)
|
|
1179
|
+
username: str | None = Field(
|
|
1180
|
+
None,
|
|
1181
|
+
description='The user name created by the seller for use on eBay. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .',
|
|
1182
|
+
)
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
class SellerCustomPolicyTypeEnum(OpenStrEnum):
|
|
1186
|
+
product_compliance = 'PRODUCT_COMPLIANCE'
|
|
1187
|
+
take_back = 'TAKE_BACK'
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
class SellerInstructionEnum(OpenStrEnum):
|
|
1191
|
+
accepts_credit_card = 'ACCEPTS_CREDIT_CARD'
|
|
1192
|
+
see_description = 'SEE_DESCRIPTION'
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
class ShipToLocation(EbayModel):
|
|
1196
|
+
country: CountryCodeEnum | None = Field(
|
|
1197
|
+
None,
|
|
1198
|
+
description='The two-letter ISO 3166 standard of the country for where the item is to be shipped.',
|
|
1199
|
+
)
|
|
1200
|
+
postal_code: str | None = Field(
|
|
1201
|
+
None,
|
|
1202
|
+
alias='postalCode',
|
|
1203
|
+
description='The zip code (postal code) for where the item is to be shipped.',
|
|
1204
|
+
)
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
class ShipToRegion(EbayModel):
|
|
1208
|
+
region_id: str | None = Field(
|
|
1209
|
+
None,
|
|
1210
|
+
alias='regionId',
|
|
1211
|
+
description='The unique identifier of the shipping region. The value returned here is dependent on the corresponding regionType value. The regionId value for a region does not vary based on the eBay marketplace. However, the corresponding regionName value for a region is a localized, text-based description of the shipping region.',
|
|
1212
|
+
)
|
|
1213
|
+
region_name: str | None = Field(
|
|
1214
|
+
None,
|
|
1215
|
+
alias='regionName',
|
|
1216
|
+
description='A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding regionType value. If the regionType value is WORLDWIDE , the regionName value will show Worldwide .',
|
|
1217
|
+
)
|
|
1218
|
+
region_type: RegionTypeEnum | None = Field(
|
|
1219
|
+
None,
|
|
1220
|
+
alias='regionType',
|
|
1221
|
+
description='An enumeration value that indicates the level or type of shipping region. Valid Values: COUNTRY_REGION - Indicates the region is a domestic region or special location within a country. STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada. COUNTRY - Indicates the region is a single country.',
|
|
1222
|
+
)
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
class SortField(EbayModel):
|
|
1226
|
+
ascending: bool | None = Field(
|
|
1227
|
+
None,
|
|
1228
|
+
description='Indicates if the results are sorted in ascending (smallest to greatest) order.',
|
|
1229
|
+
)
|
|
1230
|
+
field: str | None = Field(
|
|
1231
|
+
None,
|
|
1232
|
+
description='Specifies the name of a field in which to sort items using the value of that field. For example, if the field name is amount , the items will be sorted by the amount, or cost of the item.',
|
|
1233
|
+
)
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
class TargetLocation(EbayModel):
|
|
1237
|
+
unit_of_measure: str | None = Field(
|
|
1238
|
+
None,
|
|
1239
|
+
alias='unitOfMeasure',
|
|
1240
|
+
description="This value shows the unit of measurement used to measure the distance between the location of the item and the buyer's location. This value is typically mi or km .",
|
|
1241
|
+
)
|
|
1242
|
+
value: str | None = Field(
|
|
1243
|
+
None,
|
|
1244
|
+
description="This value indicates the distance (measured in the measurement unit in the unitOfMeasure field) between the item location and the buyer's location.",
|
|
1245
|
+
)
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
class TaxType(OpenStrEnum):
|
|
1249
|
+
state_sales_tax = 'STATE_SALES_TAX'
|
|
1250
|
+
vat = 'VAT'
|
|
1251
|
+
province_sales_tax = 'PROVINCE_SALES_TAX'
|
|
1252
|
+
region = 'REGION'
|
|
1253
|
+
gst = 'GST'
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
class TimeDurationUnitEnum(OpenStrEnum):
|
|
1257
|
+
year = 'YEAR'
|
|
1258
|
+
month = 'MONTH'
|
|
1259
|
+
day = 'DAY'
|
|
1260
|
+
hour = 'HOUR'
|
|
1261
|
+
calendar_day = 'CALENDAR_DAY'
|
|
1262
|
+
business_day = 'BUSINESS_DAY'
|
|
1263
|
+
minute = 'MINUTE'
|
|
1264
|
+
second = 'SECOND'
|
|
1265
|
+
millisecond = 'MILLISECOND'
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
class ValueTypeEnum(OpenStrEnum):
|
|
1269
|
+
string = 'STRING'
|
|
1270
|
+
string_array = 'STRING_ARRAY'
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
class VatDetail(EbayModel):
|
|
1274
|
+
issuing_country: CountryCodeEnum | None = Field(
|
|
1275
|
+
None,
|
|
1276
|
+
alias='issuingCountry',
|
|
1277
|
+
description="The two-letter ISO 3166 standard of the country issuing the seller's VAT (value added tax) ID. VAT is a tax added by some European countries.",
|
|
1278
|
+
)
|
|
1279
|
+
vat_id: str | None = Field(
|
|
1280
|
+
None,
|
|
1281
|
+
alias='vatId',
|
|
1282
|
+
description="The seller's VAT (value added tax) ID. VAT is a tax added by some European countries.",
|
|
1283
|
+
)
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
class AdditionalProductIdentity(EbayModel):
|
|
1287
|
+
product_identity: list[ProductIdentity] | None = Field(
|
|
1288
|
+
None,
|
|
1289
|
+
alias='productIdentity',
|
|
1290
|
+
description='An array of product identifier/value pairs for the product associated with the item. This is returned if the seller has associated the eBay Product Identifier (ePID) with the item and the request has fieldgroups set to PRODUCT . The following table shows what is returned, based on the item information provided by the seller, when fieldgroups is set to PRODUCT .',
|
|
1291
|
+
)
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
class Address(EbayModel):
|
|
1295
|
+
address_line1: str | None = Field(
|
|
1296
|
+
None,
|
|
1297
|
+
alias='addressLine1',
|
|
1298
|
+
description='The first line of the street address. Note: This is conditionally returned in the itemLocation field.',
|
|
1299
|
+
)
|
|
1300
|
+
address_line2: str | None = Field(
|
|
1301
|
+
None,
|
|
1302
|
+
alias='addressLine2',
|
|
1303
|
+
description='The second line of the street address. This field is not always used, but can be used for "Suite Number" or "Apt Number".',
|
|
1304
|
+
)
|
|
1305
|
+
city: str | None = Field(None, description='The city of the address.')
|
|
1306
|
+
country: CountryCodeEnum | None = Field(
|
|
1307
|
+
None,
|
|
1308
|
+
description='The two-letter ISO 3166 standard code for the country of the address.',
|
|
1309
|
+
)
|
|
1310
|
+
county: str | None = Field(None, description='The county of the address.')
|
|
1311
|
+
postal_code: str | None = Field(
|
|
1312
|
+
None,
|
|
1313
|
+
alias='postalCode',
|
|
1314
|
+
description='The postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API.',
|
|
1315
|
+
)
|
|
1316
|
+
state_or_province: str | None = Field(
|
|
1317
|
+
None,
|
|
1318
|
+
alias='stateOrProvince',
|
|
1319
|
+
description='The state or province of the address. Note: This is conditionally returned in the itemLocation field.',
|
|
1320
|
+
)
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
class Amount(EbayModel):
|
|
1324
|
+
currency: CurrencyCodeEnum | None = Field(
|
|
1325
|
+
None,
|
|
1326
|
+
description='The list of valid currencies. Each ISO 4217 currency code includes the currency name followed by the numeric value. For example, the Canadian Dollar code (CAD) would take the following form: Canadian Dollar, 124 .',
|
|
1327
|
+
)
|
|
1328
|
+
value: str | None = Field(
|
|
1329
|
+
None,
|
|
1330
|
+
description='The monetary value of the amount in the currency defined by the currency field.',
|
|
1331
|
+
)
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
class AspectDistribution(EbayModel):
|
|
1335
|
+
aspect_value_distributions: list[AspectValueDistribution] | None = Field(
|
|
1336
|
+
None,
|
|
1337
|
+
alias='aspectValueDistributions',
|
|
1338
|
+
description='An array of containers for the various values of the aspect and the match count, and a HATEOAS reference ( refinementHref ) for this aspect.',
|
|
1339
|
+
)
|
|
1340
|
+
localized_aspect_name: str | None = Field(
|
|
1341
|
+
None,
|
|
1342
|
+
alias='localizedAspectName',
|
|
1343
|
+
description='The name of an aspect, such as Brand , Color , etc.',
|
|
1344
|
+
)
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
class AvailableCoupon(EbayModel):
|
|
1348
|
+
constraint: CouponConstraint | None = Field(
|
|
1349
|
+
None, description='The limitations or restrictions of the coupon.'
|
|
1350
|
+
)
|
|
1351
|
+
discount_amount: Amount | None = Field(
|
|
1352
|
+
None,
|
|
1353
|
+
alias='discountAmount',
|
|
1354
|
+
description='The discount amount after the coupon is applied.',
|
|
1355
|
+
)
|
|
1356
|
+
discount_type: CouponDiscountType | None = Field(
|
|
1357
|
+
None,
|
|
1358
|
+
alias='discountType',
|
|
1359
|
+
description='The type of discount that the coupon applies.',
|
|
1360
|
+
)
|
|
1361
|
+
message: str | None = Field(
|
|
1362
|
+
None,
|
|
1363
|
+
description='A description of the coupon. Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response.',
|
|
1364
|
+
)
|
|
1365
|
+
redemption_code: str | None = Field(
|
|
1366
|
+
None, alias='redemptionCode', description='The coupon code.'
|
|
1367
|
+
)
|
|
1368
|
+
terms_web_url: str | None = Field(
|
|
1369
|
+
None,
|
|
1370
|
+
alias='termsWebUrl',
|
|
1371
|
+
description='The URL to the coupon terms of use. Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response.',
|
|
1372
|
+
)
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
class CompanyAddress(EbayModel):
|
|
1376
|
+
address_line1: str | None = Field(
|
|
1377
|
+
None,
|
|
1378
|
+
alias='addressLine1',
|
|
1379
|
+
description="The first line of the product manufacturer's street address.",
|
|
1380
|
+
)
|
|
1381
|
+
address_line2: str | None = Field(
|
|
1382
|
+
None,
|
|
1383
|
+
alias='addressLine2',
|
|
1384
|
+
description="The second line of the product manufacturer's street address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'.",
|
|
1385
|
+
)
|
|
1386
|
+
city: str | None = Field(
|
|
1387
|
+
None, description="The city of the product manufacturer's street address."
|
|
1388
|
+
)
|
|
1389
|
+
company_name: str | None = Field(
|
|
1390
|
+
None,
|
|
1391
|
+
alias='companyName',
|
|
1392
|
+
description='The company name of the product manufacturer.',
|
|
1393
|
+
)
|
|
1394
|
+
contact_url: str | None = Field(
|
|
1395
|
+
None,
|
|
1396
|
+
alias='contactUrl',
|
|
1397
|
+
description='The contact URL of the product manufacturer.',
|
|
1398
|
+
)
|
|
1399
|
+
country: CountryCodeEnum | None = Field(
|
|
1400
|
+
None,
|
|
1401
|
+
description='The two-letter ISO 3166 standard code for the country of the address.',
|
|
1402
|
+
)
|
|
1403
|
+
country_name: str | None = Field(
|
|
1404
|
+
None,
|
|
1405
|
+
alias='countryName',
|
|
1406
|
+
description="The country name of the product manufacturer's street address.",
|
|
1407
|
+
)
|
|
1408
|
+
county: str | None = Field(
|
|
1409
|
+
None, description="The county of the product manufacturer's street address."
|
|
1410
|
+
)
|
|
1411
|
+
email: str | None = Field(
|
|
1412
|
+
None, description="The product manufacturer's business email address."
|
|
1413
|
+
)
|
|
1414
|
+
phone: str | None = Field(
|
|
1415
|
+
None, description="The product manufacturer's business phone number."
|
|
1416
|
+
)
|
|
1417
|
+
postal_code: str | None = Field(
|
|
1418
|
+
None,
|
|
1419
|
+
alias='postalCode',
|
|
1420
|
+
description="The postal code of the product manufacturer's street address.",
|
|
1421
|
+
)
|
|
1422
|
+
state_or_province: str | None = Field(
|
|
1423
|
+
None,
|
|
1424
|
+
alias='stateOrProvince',
|
|
1425
|
+
description="The state or province of the product manufacturer's street address.",
|
|
1426
|
+
)
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
class ConditionDescriptor(EbayModel):
|
|
1430
|
+
name: str | None = Field(
|
|
1431
|
+
None,
|
|
1432
|
+
description='The name of a condition descriptor. The value(s) for this condition descriptor is returned in the associated values array.',
|
|
1433
|
+
)
|
|
1434
|
+
values: list[ConditionDescriptorValue] | None = Field(
|
|
1435
|
+
None,
|
|
1436
|
+
description='This array displays the value(s) for a condition descriptor (denoted by the associated name field), as well as any other additional information about the condition of the item.',
|
|
1437
|
+
)
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
class ConvertedAmount(EbayModel):
|
|
1441
|
+
converted_from_currency: CurrencyCodeEnum | None = Field(
|
|
1442
|
+
None,
|
|
1443
|
+
alias='convertedFromCurrency',
|
|
1444
|
+
description='The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.',
|
|
1445
|
+
)
|
|
1446
|
+
converted_from_value: str | None = Field(
|
|
1447
|
+
None,
|
|
1448
|
+
alias='convertedFromValue',
|
|
1449
|
+
description='The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.',
|
|
1450
|
+
)
|
|
1451
|
+
currency: CurrencyCodeEnum | None = Field(
|
|
1452
|
+
None,
|
|
1453
|
+
description="The three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field. Default: The currency of the authenticated user's country.",
|
|
1454
|
+
)
|
|
1455
|
+
value: str | None = Field(
|
|
1456
|
+
None,
|
|
1457
|
+
description='The monetary amount in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.',
|
|
1458
|
+
)
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
class Error(EbayModel):
|
|
1462
|
+
category: str | None = Field(None, description='Identifies the type of erro.')
|
|
1463
|
+
domain: str | None = Field(
|
|
1464
|
+
None,
|
|
1465
|
+
description='Name for the primary system where the error occurred. This is relevant for application errors.',
|
|
1466
|
+
)
|
|
1467
|
+
error_id: int | None = Field(
|
|
1468
|
+
None, alias='errorId', description='A unique number to identify the error.'
|
|
1469
|
+
)
|
|
1470
|
+
input_ref_ids: list[str] | None = Field(
|
|
1471
|
+
None,
|
|
1472
|
+
alias='inputRefIds',
|
|
1473
|
+
description='An array of request elements most closely associated to the error.',
|
|
1474
|
+
)
|
|
1475
|
+
long_message: str | None = Field(
|
|
1476
|
+
None,
|
|
1477
|
+
alias='longMessage',
|
|
1478
|
+
description='A more detailed explanation of the error.',
|
|
1479
|
+
)
|
|
1480
|
+
message: str | None = Field(
|
|
1481
|
+
None,
|
|
1482
|
+
description="Information on how to correct the problem, in the end user's terms and language where applicable.",
|
|
1483
|
+
)
|
|
1484
|
+
output_ref_ids: list[str] | None = Field(
|
|
1485
|
+
None,
|
|
1486
|
+
alias='outputRefIds',
|
|
1487
|
+
description='An array of request elements most closely associated to the error.',
|
|
1488
|
+
)
|
|
1489
|
+
parameters: list[ErrorParameter] | None = Field(
|
|
1490
|
+
None,
|
|
1491
|
+
description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.',
|
|
1492
|
+
)
|
|
1493
|
+
subdomain: str | None = Field(
|
|
1494
|
+
None,
|
|
1495
|
+
description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.',
|
|
1496
|
+
)
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
class ErrorDetailV3(EbayModel):
|
|
1500
|
+
category: str | None = Field(
|
|
1501
|
+
None,
|
|
1502
|
+
description='This string value indicates the error category. There are three categories of errors: request errors , application errors , and system errors .',
|
|
1503
|
+
)
|
|
1504
|
+
domain: str | None = Field(
|
|
1505
|
+
None,
|
|
1506
|
+
description='The name of the primary system where the error occurred. This is relevant for application errors.',
|
|
1507
|
+
)
|
|
1508
|
+
error_id: int | None = Field(
|
|
1509
|
+
None,
|
|
1510
|
+
alias='errorId',
|
|
1511
|
+
description='A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.',
|
|
1512
|
+
)
|
|
1513
|
+
input_ref_ids: list[str] | None = Field(
|
|
1514
|
+
None,
|
|
1515
|
+
alias='inputRefIds',
|
|
1516
|
+
description='An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.',
|
|
1517
|
+
)
|
|
1518
|
+
long_message: str | None = Field(
|
|
1519
|
+
None,
|
|
1520
|
+
alias='longMessage',
|
|
1521
|
+
description='A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.',
|
|
1522
|
+
)
|
|
1523
|
+
message: str | None = Field(
|
|
1524
|
+
None,
|
|
1525
|
+
description='A description of the condition that caused the error or warning.',
|
|
1526
|
+
)
|
|
1527
|
+
output_ref_ids: list[str] | None = Field(
|
|
1528
|
+
None,
|
|
1529
|
+
alias='outputRefIds',
|
|
1530
|
+
description='An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.',
|
|
1531
|
+
)
|
|
1532
|
+
parameters: list[ErrorParameterV3] | None = Field(
|
|
1533
|
+
None,
|
|
1534
|
+
description='An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.',
|
|
1535
|
+
)
|
|
1536
|
+
subdomain: str | None = Field(
|
|
1537
|
+
None,
|
|
1538
|
+
description='The name of the subdomain in which the error or warning occurred.',
|
|
1539
|
+
)
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
class FilterField(EbayModel):
|
|
1543
|
+
field: str | None = Field(
|
|
1544
|
+
None, description='Provides a way to specify the field for the filter.'
|
|
1545
|
+
)
|
|
1546
|
+
negated: bool | None = Field(
|
|
1547
|
+
None, description='Note: Currently this filter is not supported.'
|
|
1548
|
+
)
|
|
1549
|
+
range: RangeValue | None = Field(
|
|
1550
|
+
None, description='Provides a way to specify a range of values for the filter.'
|
|
1551
|
+
)
|
|
1552
|
+
set: list[str] | None = Field(
|
|
1553
|
+
None, description='Provides a way to specify a "list of values" for the filter.'
|
|
1554
|
+
)
|
|
1555
|
+
value: str | None = Field(
|
|
1556
|
+
None, description='Provides a way to specify the value of the field.'
|
|
1557
|
+
)
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
class ItemGroupSummary(EbayModel):
|
|
1561
|
+
item_group_additional_images: list[Image] | None = Field(
|
|
1562
|
+
None,
|
|
1563
|
+
alias='itemGroupAdditionalImages',
|
|
1564
|
+
description='An array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the itemGroupImage field.',
|
|
1565
|
+
)
|
|
1566
|
+
item_group_href: str | None = Field(
|
|
1567
|
+
None,
|
|
1568
|
+
alias='itemGroupHref',
|
|
1569
|
+
description='The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.',
|
|
1570
|
+
)
|
|
1571
|
+
item_group_id: str | None = Field(
|
|
1572
|
+
None,
|
|
1573
|
+
alias='itemGroupId',
|
|
1574
|
+
description='The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.',
|
|
1575
|
+
)
|
|
1576
|
+
item_group_image: Image | None = Field(
|
|
1577
|
+
None,
|
|
1578
|
+
alias='itemGroupImage',
|
|
1579
|
+
description='The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.',
|
|
1580
|
+
)
|
|
1581
|
+
item_group_title: str | None = Field(
|
|
1582
|
+
None,
|
|
1583
|
+
alias='itemGroupTitle',
|
|
1584
|
+
description='The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.',
|
|
1585
|
+
)
|
|
1586
|
+
item_group_type: ItemGroupTypeEnum | None = Field(
|
|
1587
|
+
None,
|
|
1588
|
+
alias='itemGroupType',
|
|
1589
|
+
description='An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.',
|
|
1590
|
+
)
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
class MarketingPrice(EbayModel):
|
|
1594
|
+
discount_amount: ConvertedAmount | None = Field(
|
|
1595
|
+
None,
|
|
1596
|
+
alias='discountAmount',
|
|
1597
|
+
description='This container returns the monetary amount of the seller discount.',
|
|
1598
|
+
)
|
|
1599
|
+
discount_percentage: str | None = Field(
|
|
1600
|
+
None,
|
|
1601
|
+
alias='discountPercentage',
|
|
1602
|
+
description='This field expresses the percentage of the seller discount based on the value in the originalPrice container.',
|
|
1603
|
+
)
|
|
1604
|
+
original_price: ConvertedAmount | None = Field(
|
|
1605
|
+
None,
|
|
1606
|
+
alias='originalPrice',
|
|
1607
|
+
description='This container returns the monetary amount of the item without the discount.',
|
|
1608
|
+
)
|
|
1609
|
+
price_treatment: PriceTreatmentEnum | None = Field(
|
|
1610
|
+
None,
|
|
1611
|
+
alias='priceTreatment',
|
|
1612
|
+
description='Indicates the pricing treatment (discount) that was applied to the price of the item. Note: The pricing treatment affects the way and where the discounted price can be displayed.',
|
|
1613
|
+
)
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
class PaymentMethodBrand(EbayModel):
|
|
1617
|
+
payment_method_brand_type: PaymentMethodBrandEnum | None = Field(
|
|
1618
|
+
None,
|
|
1619
|
+
alias='paymentMethodBrandType',
|
|
1620
|
+
description='The payment method brand, such as Visa or PayPal.',
|
|
1621
|
+
)
|
|
1622
|
+
logo_image: Image | None = Field(
|
|
1623
|
+
None,
|
|
1624
|
+
alias='logoImage',
|
|
1625
|
+
description='The details of the logo image, such as the size and URL. Note: Currently, only the imageUrl is populated.',
|
|
1626
|
+
)
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
class Product(EbayModel):
|
|
1630
|
+
additional_images: list[Image] | None = Field(
|
|
1631
|
+
None,
|
|
1632
|
+
alias='additionalImages',
|
|
1633
|
+
description='An array of containers with the URLs for the product images that are in addition to the primary image.',
|
|
1634
|
+
)
|
|
1635
|
+
additional_product_identities: list[AdditionalProductIdentity] | None = Field(
|
|
1636
|
+
None,
|
|
1637
|
+
alias='additionalProductIdentities',
|
|
1638
|
+
description='An array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request fieldgroups is set to PRODUCT .',
|
|
1639
|
+
)
|
|
1640
|
+
aspect_groups: list[AspectGroup] | None = Field(
|
|
1641
|
+
None,
|
|
1642
|
+
alias='aspectGroups',
|
|
1643
|
+
description='An array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs.',
|
|
1644
|
+
)
|
|
1645
|
+
brand: str | None = Field(
|
|
1646
|
+
None,
|
|
1647
|
+
description='The brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number).',
|
|
1648
|
+
)
|
|
1649
|
+
description: str | None = Field(
|
|
1650
|
+
None,
|
|
1651
|
+
description='The rich description of an eBay product, which might contain HTML.',
|
|
1652
|
+
)
|
|
1653
|
+
gtins: list[str] | None = Field(
|
|
1654
|
+
None,
|
|
1655
|
+
description='An array of all the possible GTINs values associated with the product. A GTIN is a unique Global Trade Item number of the item as defined by https://www.gtin.info . This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.',
|
|
1656
|
+
)
|
|
1657
|
+
image: Image | None = Field(
|
|
1658
|
+
None,
|
|
1659
|
+
description='The primary image of the product. This is often a stock photo.',
|
|
1660
|
+
)
|
|
1661
|
+
mpns: list[str] | None = Field(
|
|
1662
|
+
None,
|
|
1663
|
+
description='An array of all possible MPN values associated with the product. A MPNs is manufacturer part number of the product. To identify the product, this is always used along with brand.',
|
|
1664
|
+
)
|
|
1665
|
+
title: str | None = Field(None, description='The title of the product.')
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
class Refinement(EbayModel):
|
|
1669
|
+
aspect_distributions: list[AspectDistribution] | None = Field(
|
|
1670
|
+
None,
|
|
1671
|
+
alias='aspectDistributions',
|
|
1672
|
+
description='An array of containers for the all the aspect refinements.',
|
|
1673
|
+
)
|
|
1674
|
+
buying_option_distributions: list[BuyingOptionDistribution] | None = Field(
|
|
1675
|
+
None,
|
|
1676
|
+
alias='buyingOptionDistributions',
|
|
1677
|
+
description='An array of containers for the all the buying option refinements.',
|
|
1678
|
+
)
|
|
1679
|
+
category_distributions: list[CategoryDistribution] | None = Field(
|
|
1680
|
+
None,
|
|
1681
|
+
alias='categoryDistributions',
|
|
1682
|
+
description='An array of containers for the all the category refinements.',
|
|
1683
|
+
)
|
|
1684
|
+
condition_distributions: list[ConditionDistribution] | None = Field(
|
|
1685
|
+
None,
|
|
1686
|
+
alias='conditionDistributions',
|
|
1687
|
+
description='An array of containers for the all the condition refinements.',
|
|
1688
|
+
)
|
|
1689
|
+
dominant_category_id: str | None = Field(
|
|
1690
|
+
None,
|
|
1691
|
+
alias='dominantCategoryId',
|
|
1692
|
+
description='The identifier of the category that most of the items are part of.',
|
|
1693
|
+
)
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
class Region(EbayModel):
|
|
1697
|
+
region_name: str | None = Field(
|
|
1698
|
+
None,
|
|
1699
|
+
alias='regionName',
|
|
1700
|
+
description='A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax.',
|
|
1701
|
+
)
|
|
1702
|
+
region_type: RegionTypeEnum | None = Field(
|
|
1703
|
+
None,
|
|
1704
|
+
alias='regionType',
|
|
1705
|
+
description='An enumeration value that indicates the type of region for the tax jurisdiction. Valid Values: STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada. COUNTRY - Indicates the region is a single country. Code so that your app gracefully handles any future changes to this list.',
|
|
1706
|
+
)
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
class ResponsiblePerson(EbayModel):
|
|
1710
|
+
address_line1: str | None = Field(
|
|
1711
|
+
None,
|
|
1712
|
+
alias='addressLine1',
|
|
1713
|
+
description="The first line of the Responsible Person's street address.",
|
|
1714
|
+
)
|
|
1715
|
+
address_line2: str | None = Field(
|
|
1716
|
+
None,
|
|
1717
|
+
alias='addressLine2',
|
|
1718
|
+
description="The second line of the Responsible Person's address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'.",
|
|
1719
|
+
)
|
|
1720
|
+
city: str | None = Field(
|
|
1721
|
+
None, description="The city of the Responsible Person's street address."
|
|
1722
|
+
)
|
|
1723
|
+
company_name: str | None = Field(
|
|
1724
|
+
None,
|
|
1725
|
+
alias='companyName',
|
|
1726
|
+
description='The name of the Responsible Person or entity.',
|
|
1727
|
+
)
|
|
1728
|
+
contact_url: str | None = Field(
|
|
1729
|
+
None,
|
|
1730
|
+
alias='contactUrl',
|
|
1731
|
+
description='The contact URL of the Responsible Person or entity.',
|
|
1732
|
+
)
|
|
1733
|
+
country: CountryCodeEnum | None = Field(
|
|
1734
|
+
None,
|
|
1735
|
+
description='The two-letter ISO 3166 standard of the country of the address.',
|
|
1736
|
+
)
|
|
1737
|
+
country_name: str | None = Field(
|
|
1738
|
+
None,
|
|
1739
|
+
alias='countryName',
|
|
1740
|
+
description="The country name of the Responsible Person's street address.",
|
|
1741
|
+
)
|
|
1742
|
+
county: str | None = Field(
|
|
1743
|
+
None, description="The county of the Responsible Person's street address."
|
|
1744
|
+
)
|
|
1745
|
+
email: str | None = Field(
|
|
1746
|
+
None, description="The email of the Responsible Person's street address."
|
|
1747
|
+
)
|
|
1748
|
+
phone: str | None = Field(
|
|
1749
|
+
None, description="The phone number of the Responsible Person's street address."
|
|
1750
|
+
)
|
|
1751
|
+
postal_code: str | None = Field(
|
|
1752
|
+
None,
|
|
1753
|
+
alias='postalCode',
|
|
1754
|
+
description="The postal code of the Responsible Person's street address.",
|
|
1755
|
+
)
|
|
1756
|
+
state_or_province: str | None = Field(
|
|
1757
|
+
None,
|
|
1758
|
+
alias='stateOrProvince',
|
|
1759
|
+
description="The state or province of the Responsible Person's street address.",
|
|
1760
|
+
)
|
|
1761
|
+
types: list[ResponsiblePersonTypeEnum] | None = Field(
|
|
1762
|
+
None,
|
|
1763
|
+
description='The type(s) associated with the Responsible Person or entity.',
|
|
1764
|
+
)
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
class SellerCustomPolicy(EbayModel):
|
|
1768
|
+
description: str | None = Field(
|
|
1769
|
+
None, description='The seller-defined description of the policy.'
|
|
1770
|
+
)
|
|
1771
|
+
label: str | None = Field(
|
|
1772
|
+
None, description='The seller-defined label for an individual custom policy.'
|
|
1773
|
+
)
|
|
1774
|
+
type: SellerCustomPolicyTypeEnum | None = Field(
|
|
1775
|
+
None,
|
|
1776
|
+
description='The type of custom policy, such as PRODUCT_COMPLIANCE or TAKE_BACK.',
|
|
1777
|
+
)
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
class SellerLegalInfo(EbayModel):
|
|
1781
|
+
email: str | None = Field(None, description="The seller's business email address.")
|
|
1782
|
+
fax: str | None = Field(None, description="The seller' business fax number.")
|
|
1783
|
+
imprint: str | None = Field(
|
|
1784
|
+
None,
|
|
1785
|
+
description='This is a free-form string created by the seller. This is information often found on business cards, such as address. This is information used by some countries.',
|
|
1786
|
+
)
|
|
1787
|
+
legal_contact_first_name: str | None = Field(
|
|
1788
|
+
None, alias='legalContactFirstName', description="The seller's first name."
|
|
1789
|
+
)
|
|
1790
|
+
legal_contact_last_name: str | None = Field(
|
|
1791
|
+
None, alias='legalContactLastName', description="The seller's last name."
|
|
1792
|
+
)
|
|
1793
|
+
name: str | None = Field(None, description="The name of the seller's business.")
|
|
1794
|
+
phone: str | None = Field(None, description="The seller's business phone number.")
|
|
1795
|
+
registration_number: str | None = Field(
|
|
1796
|
+
None,
|
|
1797
|
+
alias='registrationNumber',
|
|
1798
|
+
description="The seller's registration number. This is information used by some countries.",
|
|
1799
|
+
)
|
|
1800
|
+
seller_provided_legal_address: LegalAddress | None = Field(
|
|
1801
|
+
None,
|
|
1802
|
+
alias='sellerProvidedLegalAddress',
|
|
1803
|
+
description="The container that returns the seller's address to be used to contact them.",
|
|
1804
|
+
)
|
|
1805
|
+
terms_of_service: str | None = Field(
|
|
1806
|
+
None,
|
|
1807
|
+
alias='termsOfService',
|
|
1808
|
+
description="This is a free-form string created by the seller. This is the seller's terms or condition, which is in addition to the seller's return policies.",
|
|
1809
|
+
)
|
|
1810
|
+
vat_details: list[VatDetail] | None = Field(
|
|
1811
|
+
None,
|
|
1812
|
+
alias='vatDetails',
|
|
1813
|
+
description="An array of the seller's VAT (value added tax) IDs and the issuing country. VAT is a tax added by some European countries.",
|
|
1814
|
+
)
|
|
1815
|
+
economic_operator: EconomicOperator | None = Field(
|
|
1816
|
+
None,
|
|
1817
|
+
alias='economicOperator',
|
|
1818
|
+
description='Provides required information about the manufacturer and/or supplier of the item.',
|
|
1819
|
+
)
|
|
1820
|
+
weee_number: str | None = Field(
|
|
1821
|
+
None,
|
|
1822
|
+
alias='weeeNumber',
|
|
1823
|
+
description='The Waste Electrical and Electronic Equipment (WEEE) registration number required for any seller to place electrical and electronic equipment on the market in Germany. This manufacturer number is assigned to the first distributors of electrical and electronic equipment and comprises a country code and an 8-digit sequence of digits (e.g. “WEEE Reg. No. DE 12345678”).',
|
|
1824
|
+
)
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
class ShipToLocations(EbayModel):
|
|
1828
|
+
region_excluded: list[ShipToRegion] | None = Field(
|
|
1829
|
+
None,
|
|
1830
|
+
alias='regionExcluded',
|
|
1831
|
+
description='An array of containers that express the large geographical regions, countries, state/provinces, or special locations within a country where the seller is not willing to ship to.',
|
|
1832
|
+
)
|
|
1833
|
+
region_included: list[ShipToRegion] | None = Field(
|
|
1834
|
+
None,
|
|
1835
|
+
alias='regionIncluded',
|
|
1836
|
+
description='An array of containers that express the large geographical regions, countries, or state/provinces within a country where the seller is willing to ship to. Prospective buyers must look at the shipping regions under this container, as well as the shipping regions that are under the regionExcluded to see where the seller is willing to ship items.',
|
|
1837
|
+
)
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
class ShippingOption(EbayModel):
|
|
1841
|
+
additional_shipping_cost_per_unit: ConvertedAmount | None = Field(
|
|
1842
|
+
None,
|
|
1843
|
+
alias='additionalShippingCostPerUnit',
|
|
1844
|
+
description="Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).",
|
|
1845
|
+
)
|
|
1846
|
+
cut_off_date_used_for_estimate: str | None = Field(
|
|
1847
|
+
None,
|
|
1848
|
+
alias='cutOffDateUsedForEstimate',
|
|
1849
|
+
description="The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.",
|
|
1850
|
+
)
|
|
1851
|
+
fulfilled_through: FulfilledThroughEnum | None = Field(
|
|
1852
|
+
None,
|
|
1853
|
+
alias='fulfilledThrough',
|
|
1854
|
+
description='If the item is being shipped by the eBay Global Shipping program , this field returns GLOBAL_SHIPPING . If the item is being shipped using the eBay International Shipping program, this field returns INTERNATIONAL_SHIPPING . Otherwise, this field is null.',
|
|
1855
|
+
)
|
|
1856
|
+
guaranteed_delivery: bool | None = Field(
|
|
1857
|
+
None,
|
|
1858
|
+
alias='guaranteedDelivery',
|
|
1859
|
+
description='Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future.',
|
|
1860
|
+
)
|
|
1861
|
+
import_charges: ConvertedAmount | None = Field(
|
|
1862
|
+
None,
|
|
1863
|
+
alias='importCharges',
|
|
1864
|
+
description='The Global Shipping Program import charges for this item.',
|
|
1865
|
+
)
|
|
1866
|
+
max_estimated_delivery_date: str | None = Field(
|
|
1867
|
+
None,
|
|
1868
|
+
alias='maxEstimatedDeliveryDate',
|
|
1869
|
+
description='The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.',
|
|
1870
|
+
)
|
|
1871
|
+
min_estimated_delivery_date: str | None = Field(
|
|
1872
|
+
None,
|
|
1873
|
+
alias='minEstimatedDeliveryDate',
|
|
1874
|
+
description='The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.',
|
|
1875
|
+
)
|
|
1876
|
+
quantity_used_for_estimate: int | None = Field(
|
|
1877
|
+
None,
|
|
1878
|
+
alias='quantityUsedForEstimate',
|
|
1879
|
+
description='The number of items used when calculating the estimation information. This field will reflect the value input in the quantity_for_shipping_estimate query parameter.',
|
|
1880
|
+
)
|
|
1881
|
+
shipping_carrier_code: str | None = Field(
|
|
1882
|
+
None,
|
|
1883
|
+
alias='shippingCarrierCode',
|
|
1884
|
+
description='The name of the shipping provider, such as FedEx, or USPS.',
|
|
1885
|
+
)
|
|
1886
|
+
shipping_cost: ConvertedAmount | None = Field(
|
|
1887
|
+
None,
|
|
1888
|
+
alias='shippingCost',
|
|
1889
|
+
description='The final shipping cost for all the items after all discounts are applied. This container will reflect the cost for the quantity specified through the quantity_for_shipping_estimate query parameter. Note: The cost does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.',
|
|
1890
|
+
)
|
|
1891
|
+
shipping_cost_type: str | None = Field(
|
|
1892
|
+
None,
|
|
1893
|
+
alias='shippingCostType',
|
|
1894
|
+
description='Indicates the class of the shipping cost. Valid Values: FIXED or CALCULATED Code so that your app gracefully handles any future changes to this list.',
|
|
1895
|
+
)
|
|
1896
|
+
shipping_service_code: str | None = Field(
|
|
1897
|
+
None,
|
|
1898
|
+
alias='shippingServiceCode',
|
|
1899
|
+
description='The type of shipping service. For example, USPS First Class.',
|
|
1900
|
+
)
|
|
1901
|
+
ship_to_location_used_for_estimate: ShipToLocation | None = Field(
|
|
1902
|
+
None,
|
|
1903
|
+
alias='shipToLocationUsedForEstimate',
|
|
1904
|
+
description='The container that returns the country and postal code of where the item is to be shipped. These values come from the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. If the header is not submitted, marketplace is used.',
|
|
1905
|
+
)
|
|
1906
|
+
trademark_symbol: str | None = Field(
|
|
1907
|
+
None,
|
|
1908
|
+
alias='trademarkSymbol',
|
|
1909
|
+
description='Any trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name.',
|
|
1910
|
+
)
|
|
1911
|
+
type: str | None = Field(
|
|
1912
|
+
None,
|
|
1913
|
+
description='The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.',
|
|
1914
|
+
)
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
class ShippingOptionSummary(EbayModel):
|
|
1918
|
+
guaranteed_delivery: bool | None = Field(
|
|
1919
|
+
None,
|
|
1920
|
+
alias='guaranteedDelivery',
|
|
1921
|
+
description='Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future.',
|
|
1922
|
+
)
|
|
1923
|
+
max_estimated_delivery_date: str | None = Field(
|
|
1924
|
+
None,
|
|
1925
|
+
alias='maxEstimatedDeliveryDate',
|
|
1926
|
+
description='The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. Note: Estimated delivery dates are not returned for CBT items.',
|
|
1927
|
+
)
|
|
1928
|
+
min_estimated_delivery_date: str | None = Field(
|
|
1929
|
+
None,
|
|
1930
|
+
alias='minEstimatedDeliveryDate',
|
|
1931
|
+
description='The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. Note: Estimated delivery dates are not returned for CBT items.',
|
|
1932
|
+
)
|
|
1933
|
+
shipping_cost: ConvertedAmount | None = Field(
|
|
1934
|
+
None,
|
|
1935
|
+
alias='shippingCost',
|
|
1936
|
+
description='This is the estimated price to ship the item. The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.',
|
|
1937
|
+
)
|
|
1938
|
+
shipping_cost_type: str | None = Field(
|
|
1939
|
+
None,
|
|
1940
|
+
alias='shippingCostType',
|
|
1941
|
+
description='Indicates the type of shipping used to ship the item. Possible values are FIXED (flat-rate shipping) and CALCULATED (shipping cost calculated based on item and buyer location).',
|
|
1942
|
+
)
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
class TaxJurisdiction(EbayModel):
|
|
1946
|
+
region: Region | None = Field(
|
|
1947
|
+
None, description='The region of the tax jurisdiction.'
|
|
1948
|
+
)
|
|
1949
|
+
tax_jurisdiction_id: str | None = Field(
|
|
1950
|
+
None,
|
|
1951
|
+
alias='taxJurisdictionId',
|
|
1952
|
+
description='The identifier of the tax jurisdiction.',
|
|
1953
|
+
)
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
class Taxes(EbayModel):
|
|
1957
|
+
ebay_collect_and_remit_tax: bool | None = Field(
|
|
1958
|
+
None,
|
|
1959
|
+
alias='ebayCollectAndRemitTax',
|
|
1960
|
+
description="This field is only returned if true , and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence.",
|
|
1961
|
+
)
|
|
1962
|
+
included_in_price: bool | None = Field(
|
|
1963
|
+
None,
|
|
1964
|
+
alias='includedInPrice',
|
|
1965
|
+
description='This indicates if tax was applied for the cost of the item.',
|
|
1966
|
+
)
|
|
1967
|
+
shipping_and_handling_taxed: bool | None = Field(
|
|
1968
|
+
None,
|
|
1969
|
+
alias='shippingAndHandlingTaxed',
|
|
1970
|
+
description='This indicates if tax is applied for the shipping cost.',
|
|
1971
|
+
)
|
|
1972
|
+
tax_jurisdiction: TaxJurisdiction | None = Field(
|
|
1973
|
+
None,
|
|
1974
|
+
alias='taxJurisdiction',
|
|
1975
|
+
description='The container that returns the tax jurisdiction.',
|
|
1976
|
+
)
|
|
1977
|
+
tax_percentage: str | None = Field(
|
|
1978
|
+
None, alias='taxPercentage', description='The percentage of tax.'
|
|
1979
|
+
)
|
|
1980
|
+
tax_type: TaxType | None = Field(
|
|
1981
|
+
None,
|
|
1982
|
+
alias='taxType',
|
|
1983
|
+
description='This field indicates the type of tax that may be collected for the item.',
|
|
1984
|
+
)
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
class TimeDuration(EbayModel):
|
|
1988
|
+
unit: TimeDurationUnitEnum | None = Field(
|
|
1989
|
+
None,
|
|
1990
|
+
description='An enumeration value that indicates the units of the time span (e.g., HOURS ). The enumeration value in this field defines the period of time being used to measure the duration. Refer to TimeDurationUnitEnum for the list of supported values.',
|
|
1991
|
+
)
|
|
1992
|
+
value: int | None = Field(
|
|
1993
|
+
None,
|
|
1994
|
+
description='Retrieves the duration of the time span (no units). The value in this field indicates the number of years, months, days, hours, or minutes in the defined period.',
|
|
1995
|
+
)
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
class TypedNameValue(EbayModel):
|
|
1999
|
+
name: str | None = Field(
|
|
2000
|
+
None,
|
|
2001
|
+
description='The text representing the name of the aspect for the name/value pair, such as Color.',
|
|
2002
|
+
)
|
|
2003
|
+
type: ValueTypeEnum | None = Field(
|
|
2004
|
+
None,
|
|
2005
|
+
description='This indicates if the value being returned is a string or an array of values. Valid Values: STRING - Indicates the value returned is a string. STRING_ARRAY - Indicates the value returned is an array of strings. Code so that your app gracefully handles any future changes to this list.',
|
|
2006
|
+
)
|
|
2007
|
+
value: str | None = Field(
|
|
2008
|
+
None,
|
|
2009
|
+
description='The value of the aspect for the name/value pair, such as Red.',
|
|
2010
|
+
)
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
class AddonService(EbayModel):
|
|
2014
|
+
selection: AddonServiceSelectionEnum | None = Field(
|
|
2015
|
+
None,
|
|
2016
|
+
description='This field indicates whether the add-on service must be selected for the item.',
|
|
2017
|
+
)
|
|
2018
|
+
service_fee: ConvertedAmount | None = Field(
|
|
2019
|
+
None,
|
|
2020
|
+
alias='serviceFee',
|
|
2021
|
+
description='The amount charged for the add-on service.',
|
|
2022
|
+
)
|
|
2023
|
+
service_id: str | None = Field(
|
|
2024
|
+
None, alias='serviceId', description='The ID number of the add-on service.'
|
|
2025
|
+
)
|
|
2026
|
+
service_type: AddonServiceTypeEnum | None = Field(
|
|
2027
|
+
None,
|
|
2028
|
+
alias='serviceType',
|
|
2029
|
+
description='The type of add-on service, such as AUTHENTICITY_GUARANTEE .',
|
|
2030
|
+
)
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
class AspectFilter(EbayModel):
|
|
2034
|
+
category_id: str | None = Field(
|
|
2035
|
+
None,
|
|
2036
|
+
alias='categoryId',
|
|
2037
|
+
description='The ID of the category. This limits the aspects filtering to this category.',
|
|
2038
|
+
)
|
|
2039
|
+
filters: list[FilterField] | None = Field(
|
|
2040
|
+
None,
|
|
2041
|
+
description='This query parameter supports multiple field filters that can be used to limit/customize the result set. This is specific to limiting the items return based on item aspects, such as Brand . For an example, refer to the Samples section.',
|
|
2042
|
+
)
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
class CompatibilityFilter(EbayModel):
|
|
2046
|
+
filters: list[FilterField] | None = Field(
|
|
2047
|
+
None,
|
|
2048
|
+
description='This query parameter supports multiple field filters that can be used to limit/customize the result set. This is specific to checking if an item is compatible to the specified a product.',
|
|
2049
|
+
)
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
class CompatibilityResponse(EbayModel):
|
|
2053
|
+
compatibility_status: CompatibilityStatus | None = Field(
|
|
2054
|
+
None,
|
|
2055
|
+
alias='compatibilityStatus',
|
|
2056
|
+
description='An enumeration value that tells you if the item is compatible with the product. The values are: COMPATIBLE - Indicates the item is compatible with the product specified in the request. NOT_COMPATIBLE - Indicates the item is not compatible with the product specified in the request. Be sure to check all the value fields to ensure they are correct as errors in the value can also cause this response.',
|
|
2057
|
+
)
|
|
2058
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2059
|
+
None,
|
|
2060
|
+
description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.',
|
|
2061
|
+
)
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
class ItemReturnTerms(EbayModel):
|
|
2065
|
+
extended_holiday_returns_offered: bool | None = Field(
|
|
2066
|
+
None,
|
|
2067
|
+
alias='extendedHolidayReturnsOffered',
|
|
2068
|
+
description="This indicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the returnPeriod value.",
|
|
2069
|
+
)
|
|
2070
|
+
refund_method: RefundMethodEnum | None = Field(
|
|
2071
|
+
None,
|
|
2072
|
+
alias='refundMethod',
|
|
2073
|
+
description='An enumeration value that indicates how a buyer is refunded when an item is returned. Valid Values: MONEY_BACK or MERCHANDISE_CREDIT Code so that your app gracefully handles any future changes to this list.',
|
|
2074
|
+
)
|
|
2075
|
+
restocking_fee_percentage: str | None = Field(
|
|
2076
|
+
None,
|
|
2077
|
+
alias='restockingFeePercentage',
|
|
2078
|
+
description='This string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent.',
|
|
2079
|
+
)
|
|
2080
|
+
return_instructions: str | None = Field(
|
|
2081
|
+
None,
|
|
2082
|
+
alias='returnInstructions',
|
|
2083
|
+
description='Text written by the seller describing what the buyer needs to do in order to return the item.',
|
|
2084
|
+
)
|
|
2085
|
+
return_method: ReturnMethodEnum | None = Field(
|
|
2086
|
+
None,
|
|
2087
|
+
alias='returnMethod',
|
|
2088
|
+
description='An enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund.',
|
|
2089
|
+
)
|
|
2090
|
+
return_period: TimeDuration | None = Field(
|
|
2091
|
+
None,
|
|
2092
|
+
alias='returnPeriod',
|
|
2093
|
+
description='The amount of time the buyer has to return the item after the purchase date.',
|
|
2094
|
+
)
|
|
2095
|
+
returns_accepted: bool | None = Field(
|
|
2096
|
+
None,
|
|
2097
|
+
alias='returnsAccepted',
|
|
2098
|
+
description='Indicates whether the seller accepts returns for the item.',
|
|
2099
|
+
)
|
|
2100
|
+
return_shipping_cost_payer: ReturnShippingCostPayerEnum | None = Field(
|
|
2101
|
+
None,
|
|
2102
|
+
alias='returnShippingCostPayer',
|
|
2103
|
+
description='This enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned. Valid Values: SELLER - Indicates the seller will pay for the shipping costs to return the item. BUYER - Indicates the buyer will pay for the shipping costs to return the item. Code so that your app gracefully handles any future changes to this list.',
|
|
2104
|
+
)
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
class ItemSummary(EbayModel):
|
|
2108
|
+
additional_images: list[Image] | None = Field(
|
|
2109
|
+
None,
|
|
2110
|
+
alias='additionalImages',
|
|
2111
|
+
description='An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.',
|
|
2112
|
+
)
|
|
2113
|
+
adult_only: bool | None = Field(
|
|
2114
|
+
None,
|
|
2115
|
+
alias='adultOnly',
|
|
2116
|
+
description='This indicates if the item is for adults only. For more information about adult-only items on eBay, refer to the Adult items policy .',
|
|
2117
|
+
)
|
|
2118
|
+
available_coupons: bool | None = Field(
|
|
2119
|
+
None,
|
|
2120
|
+
alias='availableCoupons',
|
|
2121
|
+
description='This boolean attribute indicates if coupons are available for the item. Note: The Browse API only acknowledges item-level coupons. This field will only be returned as true if a coupon is linked with an item. It does not recognize store-level coupons offered by sellers across their entire store.',
|
|
2122
|
+
)
|
|
2123
|
+
bid_count: int | None = Field(
|
|
2124
|
+
None,
|
|
2125
|
+
alias='bidCount',
|
|
2126
|
+
description='This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items.',
|
|
2127
|
+
)
|
|
2128
|
+
buying_options: list[str] | None = Field(
|
|
2129
|
+
None,
|
|
2130
|
+
alias='buyingOptions',
|
|
2131
|
+
description='A comma separated list of all the purchase options available for the item. Values Returned: FIXED_PRICE Indicates the buyer can purchase the item for a set price using the Buy It Now button. AUCTION Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.',
|
|
2132
|
+
)
|
|
2133
|
+
categories: list[Category] | None = Field(
|
|
2134
|
+
None,
|
|
2135
|
+
description='This array returns the name and ID of each category associated with the item, including top level, branch, and leaf categories.',
|
|
2136
|
+
)
|
|
2137
|
+
compatibility_match: CompatibilityMatchEnum | None = Field(
|
|
2138
|
+
None,
|
|
2139
|
+
alias='compatibilityMatch',
|
|
2140
|
+
description='This indicates how well an item matches the compatibility_filter product attributes. Valid Values: EXACT POSSIBLE',
|
|
2141
|
+
)
|
|
2142
|
+
compatibility_properties: list[CompatibilityProperty] | None = Field(
|
|
2143
|
+
None,
|
|
2144
|
+
alias='compatibilityProperties',
|
|
2145
|
+
description='This container returns only the product attributes that are compatible with the item. These attributes were specified in the compatibility_filter in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned.',
|
|
2146
|
+
)
|
|
2147
|
+
condition: str | None = Field(
|
|
2148
|
+
None,
|
|
2149
|
+
description='The text describing the condition of the item, such as New or Used . For a list of condition names, refer to Item Condition IDs and Names .',
|
|
2150
|
+
)
|
|
2151
|
+
condition_id: str | None = Field(
|
|
2152
|
+
None,
|
|
2153
|
+
alias='conditionId',
|
|
2154
|
+
description='The identifier of the condition of the item. For example, 1000 is the identifier for NEW . For a list of condition names and IDs, refer to Item Condition IDs and Names .',
|
|
2155
|
+
)
|
|
2156
|
+
current_bid_price: ConvertedAmount | None = Field(
|
|
2157
|
+
None,
|
|
2158
|
+
alias='currentBidPrice',
|
|
2159
|
+
description='This container returns the current highest bid for an auction item. The value field shows the dollar value of the current highest bid, and the currency field (3-digit ISO code) denotes the currency associated with that bid value. This field is only returned for auction items.',
|
|
2160
|
+
)
|
|
2161
|
+
distance_from_pickup_location: TargetLocation | None = Field(
|
|
2162
|
+
None,
|
|
2163
|
+
alias='distanceFromPickupLocation',
|
|
2164
|
+
description='This container returns the distance away that the item is from the pickupPostalCode value that was supplied in the method request. This container is only returned if the "local pickup" filter fields are used in the request.',
|
|
2165
|
+
)
|
|
2166
|
+
energy_efficiency_class: str | None = Field(
|
|
2167
|
+
None,
|
|
2168
|
+
alias='energyEfficiencyClass',
|
|
2169
|
+
description='This indicates the European energy efficiency rating (EEK) of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only. Currently, this field is only applicable for the Germany site, and is returned only if the seller specifies the energy efficiency rating through item specifics at listing time.',
|
|
2170
|
+
)
|
|
2171
|
+
epid: str | None = Field(
|
|
2172
|
+
None,
|
|
2173
|
+
description='An ePID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.',
|
|
2174
|
+
)
|
|
2175
|
+
image: Image | None = Field(
|
|
2176
|
+
None, description='The URL to the primary image of the item.'
|
|
2177
|
+
)
|
|
2178
|
+
item_affiliate_web_url: str | None = Field(
|
|
2179
|
+
None,
|
|
2180
|
+
alias='itemAffiliateWebUrl',
|
|
2181
|
+
description='The URL to the View Item page of the item which includes the affiliate tracking ID. Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace. The itemAffiliateWebUrl is returned only if: The marketplace through which the item is being viewed is part of the eBay Partner Network.',
|
|
2182
|
+
)
|
|
2183
|
+
item_creation_date: str | None = Field(
|
|
2184
|
+
None,
|
|
2185
|
+
alias='itemCreationDate',
|
|
2186
|
+
description='The date and time when the item listing was created. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which you can convert into the local time of the buyer. This field is always returned with itemSummaries .',
|
|
2187
|
+
)
|
|
2188
|
+
item_end_date: str | None = Field(
|
|
2189
|
+
None,
|
|
2190
|
+
alias='itemEndDate',
|
|
2191
|
+
description='A timestamp that indicates the date and time a listing is scheduled to end. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.',
|
|
2192
|
+
)
|
|
2193
|
+
item_group_href: str | None = Field(
|
|
2194
|
+
None,
|
|
2195
|
+
alias='itemGroupHref',
|
|
2196
|
+
description='The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Note: This field is returned only for item groups.',
|
|
2197
|
+
)
|
|
2198
|
+
item_group_type: str | None = Field(
|
|
2199
|
+
None,
|
|
2200
|
+
alias='itemGroupType',
|
|
2201
|
+
description='The indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Currently only the SELLER_DEFINED_VARIATIONS is supported and indicates this is an item group created by the seller. Note: This field is returned only for item groups.',
|
|
2202
|
+
)
|
|
2203
|
+
item_href: str | None = Field(
|
|
2204
|
+
None,
|
|
2205
|
+
alias='itemHref',
|
|
2206
|
+
description='The URI for the Browse API getItem method, which can be used to retrieve more details about items in the search results.',
|
|
2207
|
+
)
|
|
2208
|
+
item_id: str | None = Field(
|
|
2209
|
+
None, alias='itemId', description='The unique RESTful identifier of the item.'
|
|
2210
|
+
)
|
|
2211
|
+
item_location: ItemLocationImpl | None = Field(
|
|
2212
|
+
None,
|
|
2213
|
+
alias='itemLocation',
|
|
2214
|
+
description='This container returns the location of the item. This container consists of fields you typically see for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code).',
|
|
2215
|
+
)
|
|
2216
|
+
item_origin_date: str | None = Field(
|
|
2217
|
+
None,
|
|
2218
|
+
alias='itemOriginDate',
|
|
2219
|
+
description='The date and time when the listing was first made available. This date will be retained if an item is relisted. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which you can convert into the local time of the buyer. This timestamp is used to sort the response when the sort=newlyListed parameter is used. This field is always returned with itemSummaries .',
|
|
2220
|
+
)
|
|
2221
|
+
item_web_url: str | None = Field(
|
|
2222
|
+
None,
|
|
2223
|
+
alias='itemWebUrl',
|
|
2224
|
+
description='The URL to the View Item page of the item. This enables you to include a "Report Item on eBay" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.',
|
|
2225
|
+
)
|
|
2226
|
+
leaf_category_ids: list[str] | None = Field(
|
|
2227
|
+
None,
|
|
2228
|
+
alias='leafCategoryIds',
|
|
2229
|
+
description='The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary.',
|
|
2230
|
+
)
|
|
2231
|
+
legacy_item_id: str | None = Field(
|
|
2232
|
+
None,
|
|
2233
|
+
alias='legacyItemId',
|
|
2234
|
+
description='The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.',
|
|
2235
|
+
)
|
|
2236
|
+
listing_marketplace_id: MarketplaceIdEnum | None = Field(
|
|
2237
|
+
None,
|
|
2238
|
+
alias='listingMarketplaceId',
|
|
2239
|
+
description='The ID of the eBay marketplace on which the seller listed the item.',
|
|
2240
|
+
)
|
|
2241
|
+
marketing_price: MarketingPrice | None = Field(
|
|
2242
|
+
None,
|
|
2243
|
+
alias='marketingPrice',
|
|
2244
|
+
description="This container is returned if the item is eligible for a seller discount and contains the item's original price, and the seller discount amount and percentage.",
|
|
2245
|
+
)
|
|
2246
|
+
pickup_options: list[PickupOptionSummary] | None = Field(
|
|
2247
|
+
None,
|
|
2248
|
+
alias='pickupOptions',
|
|
2249
|
+
description='This container returns the local pickup options available to the buyer. This container is returned only if the user is searching for local pickup items and set the local pickup filters in the method request.',
|
|
2250
|
+
)
|
|
2251
|
+
price: ConvertedAmount | None = Field(
|
|
2252
|
+
None,
|
|
2253
|
+
description='The price of the item after it has been converted into another currency. The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.',
|
|
2254
|
+
)
|
|
2255
|
+
price_display_condition: PriceDisplayConditionEnum | None = Field(
|
|
2256
|
+
None,
|
|
2257
|
+
alias='priceDisplayCondition',
|
|
2258
|
+
description="Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.",
|
|
2259
|
+
)
|
|
2260
|
+
priority_listing: bool | None = Field(
|
|
2261
|
+
None,
|
|
2262
|
+
alias='priorityListing',
|
|
2263
|
+
description='This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. Note: Priority Listing is returned only with a Best Match sort and will not be returned for other sort options.',
|
|
2264
|
+
)
|
|
2265
|
+
qualified_programs: list[str] | None = Field(
|
|
2266
|
+
None,
|
|
2267
|
+
alias='qualifiedPrograms',
|
|
2268
|
+
description='An array of the qualified programs available for the item, such as EBAY_PLUS , AUTHENTICITY_GUARANTEE , and AUTHENTICITY_VERIFICATION . eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.',
|
|
2269
|
+
)
|
|
2270
|
+
seller: Seller | None = Field(
|
|
2271
|
+
None,
|
|
2272
|
+
description='This container returns basic information about the seller of the item, such as name, feedback score, etc.',
|
|
2273
|
+
)
|
|
2274
|
+
shipping_options: list[ShippingOptionSummary] | None = Field(
|
|
2275
|
+
None,
|
|
2276
|
+
alias='shippingOptions',
|
|
2277
|
+
description='This container returns the shipping options available to ship the item.',
|
|
2278
|
+
)
|
|
2279
|
+
short_description: str | None = Field(
|
|
2280
|
+
None,
|
|
2281
|
+
alias='shortDescription',
|
|
2282
|
+
description='This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.) Sometimes the title does not provide enough information but the description is too big. Surfacing the shortDescription can often provide buyers with the additional information that could help them make a buying decision.',
|
|
2283
|
+
)
|
|
2284
|
+
thumbnail_images: list[Image] | None = Field(
|
|
2285
|
+
None,
|
|
2286
|
+
alias='thumbnailImages',
|
|
2287
|
+
description='An array of thumbnail images for the item.',
|
|
2288
|
+
)
|
|
2289
|
+
title: str | None = Field(
|
|
2290
|
+
None,
|
|
2291
|
+
description='The seller-created title of the item. Maximum Length: 80 characters',
|
|
2292
|
+
)
|
|
2293
|
+
top_rated_buying_experience: bool | None = Field(
|
|
2294
|
+
None,
|
|
2295
|
+
alias='topRatedBuyingExperience',
|
|
2296
|
+
description='This indicates if the item is a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy; shipping the item in 1 business day with tracking provided; and the added comfort of knowing that this item is from an experienced seller with the highest buyer ratings.',
|
|
2297
|
+
)
|
|
2298
|
+
tyre_label_image_url: str | None = Field(
|
|
2299
|
+
None,
|
|
2300
|
+
alias='tyreLabelImageUrl',
|
|
2301
|
+
description='The URL to the image that shows the information on the tyre label.',
|
|
2302
|
+
)
|
|
2303
|
+
unit_price: ConvertedAmount | None = Field(
|
|
2304
|
+
None,
|
|
2305
|
+
alias='unitPrice',
|
|
2306
|
+
description='The price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
|
|
2307
|
+
)
|
|
2308
|
+
unit_pricing_measure: str | None = Field(
|
|
2309
|
+
None,
|
|
2310
|
+
alias='unitPricingMeasure',
|
|
2311
|
+
description='The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
|
|
2312
|
+
)
|
|
2313
|
+
watch_count: int | None = Field(
|
|
2314
|
+
None,
|
|
2315
|
+
alias='watchCount',
|
|
2316
|
+
description='The number of users that have added the item to their watch list. Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access.',
|
|
2317
|
+
)
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
class PaymentMethod(EbayModel):
|
|
2321
|
+
payment_method_type: PaymentMethodTypeEnum | None = Field(
|
|
2322
|
+
None,
|
|
2323
|
+
alias='paymentMethodType',
|
|
2324
|
+
description='The payment method type, such as credit card or cash.',
|
|
2325
|
+
)
|
|
2326
|
+
payment_method_brands: list[PaymentMethodBrand] | None = Field(
|
|
2327
|
+
None,
|
|
2328
|
+
alias='paymentMethodBrands',
|
|
2329
|
+
description='The payment method brands, including the payment method brand type and logo image.',
|
|
2330
|
+
)
|
|
2331
|
+
payment_instructions: list[PaymentInstructionEnum] | None = Field(
|
|
2332
|
+
None,
|
|
2333
|
+
alias='paymentInstructions',
|
|
2334
|
+
description='The payment instructions for the buyer, such as cash in person or contact seller .',
|
|
2335
|
+
)
|
|
2336
|
+
seller_instructions: list[SellerInstructionEnum] | None = Field(
|
|
2337
|
+
None,
|
|
2338
|
+
alias='sellerInstructions',
|
|
2339
|
+
description='The seller instructions to the buyer, such as accepts credit cards or see description .',
|
|
2340
|
+
)
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
class SearchPagedCollection(EbayModel):
|
|
2344
|
+
auto_corrections: AutoCorrections | None = Field(
|
|
2345
|
+
None, alias='autoCorrections', description='The auto-corrected inputs.'
|
|
2346
|
+
)
|
|
2347
|
+
href: str | None = Field(
|
|
2348
|
+
None,
|
|
2349
|
+
description='The URI of the current page of results. The following example of the search method returns items 1 thru 5 from the list of items found. https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0',
|
|
2350
|
+
)
|
|
2351
|
+
item_summaries: list[ItemSummary] | None = Field(
|
|
2352
|
+
None,
|
|
2353
|
+
alias='itemSummaries',
|
|
2354
|
+
description='An array of the items on this page. The items are sorted according to the sorting method specified in the request.',
|
|
2355
|
+
)
|
|
2356
|
+
limit: int | None = Field(
|
|
2357
|
+
None,
|
|
2358
|
+
description='The value of the limit parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method.',
|
|
2359
|
+
)
|
|
2360
|
+
next: str | None = Field(
|
|
2361
|
+
None,
|
|
2362
|
+
description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. The following example of the search method returns items 5 thru 10 from the list of items found. https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10',
|
|
2363
|
+
)
|
|
2364
|
+
offset: int | None = Field(
|
|
2365
|
+
None,
|
|
2366
|
+
description='This value indicates the offset used for current page of items being returned. Assume the initial request used an offset of 0 and a limit of 3 . Then in the first page of results, this value would be 0 , and items 1-3 are returned. For the second page, this value is 3 and so on.',
|
|
2367
|
+
)
|
|
2368
|
+
prev: str | None = Field(
|
|
2369
|
+
None,
|
|
2370
|
+
description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set. The following example of the search method returns items 1 thru 5 from the list of items found, which would be the first set of items returned. https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0',
|
|
2371
|
+
)
|
|
2372
|
+
refinement: Refinement | None = Field(
|
|
2373
|
+
None, description='The container for all the search refinements.'
|
|
2374
|
+
)
|
|
2375
|
+
total: int | None = Field(
|
|
2376
|
+
None,
|
|
2377
|
+
description='The total number of items that match the input criteria. Note: total is just an indicator of the number of listings for a given query. It could vary based on the number of listings with variations included in the result. It is strongly recommended that total not be used in pagination use cases. Instead, use next to determine the results on the next page.',
|
|
2378
|
+
)
|
|
2379
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
2380
|
+
None, description='The container with all the warnings for the request.'
|
|
2381
|
+
)
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
class SellerDetail(EbayModel):
|
|
2385
|
+
feedback_percentage: str | None = Field(
|
|
2386
|
+
None,
|
|
2387
|
+
alias='feedbackPercentage',
|
|
2388
|
+
description='The percentage of the total positive feedback.',
|
|
2389
|
+
)
|
|
2390
|
+
feedback_score: int | None = Field(
|
|
2391
|
+
None,
|
|
2392
|
+
alias='feedbackScore',
|
|
2393
|
+
description='The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.',
|
|
2394
|
+
)
|
|
2395
|
+
seller_account_type: str | None = Field(
|
|
2396
|
+
None,
|
|
2397
|
+
alias='sellerAccountType',
|
|
2398
|
+
description='This indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS . If they register for a private account, this value will be INDIVIDUAL .',
|
|
2399
|
+
)
|
|
2400
|
+
seller_legal_info: SellerLegalInfo | None = Field(
|
|
2401
|
+
None,
|
|
2402
|
+
alias='sellerLegalInfo',
|
|
2403
|
+
description="The container with the seller's contact info and fields that are required by law.",
|
|
2404
|
+
)
|
|
2405
|
+
user_id: str | None = Field(
|
|
2406
|
+
None,
|
|
2407
|
+
alias='userId',
|
|
2408
|
+
description='The unique identifier of an eBay user across all eBay sites. This value does not change, even when a user changes their username.',
|
|
2409
|
+
)
|
|
2410
|
+
username: str | None = Field(
|
|
2411
|
+
None,
|
|
2412
|
+
description='The user name created by the seller for use on eBay. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .',
|
|
2413
|
+
)
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
class CoreItem(EbayModel):
|
|
2417
|
+
additional_images: list[Image] | None = Field(
|
|
2418
|
+
None,
|
|
2419
|
+
alias='additionalImages',
|
|
2420
|
+
description='An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.',
|
|
2421
|
+
)
|
|
2422
|
+
adult_only: bool | None = Field(
|
|
2423
|
+
None,
|
|
2424
|
+
alias='adultOnly',
|
|
2425
|
+
description='This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers.',
|
|
2426
|
+
)
|
|
2427
|
+
age_group: str | None = Field(
|
|
2428
|
+
None,
|
|
2429
|
+
alias='ageGroup',
|
|
2430
|
+
description='(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2431
|
+
)
|
|
2432
|
+
authenticity_guarantee: AuthenticityGuaranteeProgram | None = Field(
|
|
2433
|
+
None,
|
|
2434
|
+
alias='authenticityGuarantee',
|
|
2435
|
+
description='A container for information about whether an item is qualified for the Authenticity Guarantee program. Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer.',
|
|
2436
|
+
)
|
|
2437
|
+
authenticity_verification: AuthenticityVerificationProgram | None = Field(
|
|
2438
|
+
None,
|
|
2439
|
+
alias='authenticityVerification',
|
|
2440
|
+
description='A container for information about whether an item is from a verified seller.',
|
|
2441
|
+
)
|
|
2442
|
+
available_coupons: list[AvailableCoupon] | None = Field(
|
|
2443
|
+
None,
|
|
2444
|
+
alias='availableCoupons',
|
|
2445
|
+
description='A list of available coupons for the item.',
|
|
2446
|
+
)
|
|
2447
|
+
bid_count: int | None = Field(
|
|
2448
|
+
None,
|
|
2449
|
+
alias='bidCount',
|
|
2450
|
+
description='This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.',
|
|
2451
|
+
)
|
|
2452
|
+
brand: str | None = Field(
|
|
2453
|
+
None,
|
|
2454
|
+
description='(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2455
|
+
)
|
|
2456
|
+
buying_options: list[str] | None = Field(
|
|
2457
|
+
None,
|
|
2458
|
+
alias='buyingOptions',
|
|
2459
|
+
description='A comma separated list of all the purchase options available for the item. The values returned are: FIXED_PRICE - Indicates the buyer can purchase the item for a set price using the Buy It Now button. AUCTION - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.',
|
|
2460
|
+
)
|
|
2461
|
+
category_id: str | None = Field(
|
|
2462
|
+
None,
|
|
2463
|
+
alias='categoryId',
|
|
2464
|
+
description='The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children.',
|
|
2465
|
+
)
|
|
2466
|
+
category_path: str | None = Field(
|
|
2467
|
+
None,
|
|
2468
|
+
alias='categoryPath',
|
|
2469
|
+
description='Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks',
|
|
2470
|
+
)
|
|
2471
|
+
color: str | None = Field(
|
|
2472
|
+
None,
|
|
2473
|
+
description='(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2474
|
+
)
|
|
2475
|
+
charity_terms: ItemCharityTerms | None = Field(
|
|
2476
|
+
None,
|
|
2477
|
+
alias='charityTerms',
|
|
2478
|
+
description='This container returns any applicable charity information associated with the specified item. This container is only returned if the fieldgroups query parameter is set to CHARITY_DETAILS .',
|
|
2479
|
+
)
|
|
2480
|
+
condition: str | None = Field(
|
|
2481
|
+
None,
|
|
2482
|
+
description='A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.',
|
|
2483
|
+
)
|
|
2484
|
+
condition_description: str | None = Field(
|
|
2485
|
+
None,
|
|
2486
|
+
alias='conditionDescription',
|
|
2487
|
+
description='A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item.',
|
|
2488
|
+
)
|
|
2489
|
+
condition_id: str | None = Field(
|
|
2490
|
+
None,
|
|
2491
|
+
alias='conditionId',
|
|
2492
|
+
description='The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.',
|
|
2493
|
+
)
|
|
2494
|
+
current_bid_price: ConvertedAmount | None = Field(
|
|
2495
|
+
None,
|
|
2496
|
+
alias='currentBidPrice',
|
|
2497
|
+
description='The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.',
|
|
2498
|
+
)
|
|
2499
|
+
description: str | None = Field(
|
|
2500
|
+
None,
|
|
2501
|
+
description='The full description of the item that was created by the seller. This can be plain text or rich content and can be very large.',
|
|
2502
|
+
)
|
|
2503
|
+
eligible_for_inline_checkout: bool | None = Field(
|
|
2504
|
+
None,
|
|
2505
|
+
alias='eligibleForInlineCheckout',
|
|
2506
|
+
description='This field indicates if the item can be purchased using the Buy Order API . If the value of this field is true , this indicates that the item can be purchased using the Order API . If the value of this field is false , this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.',
|
|
2507
|
+
)
|
|
2508
|
+
enabled_for_guest_checkout: bool | None = Field(
|
|
2509
|
+
None,
|
|
2510
|
+
alias='enabledForGuestCheckout',
|
|
2511
|
+
description='This indicates if the item can be purchased using Guest Checkout in the Order API . You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards.',
|
|
2512
|
+
)
|
|
2513
|
+
energy_efficiency_class: str | None = Field(
|
|
2514
|
+
None,
|
|
2515
|
+
alias='energyEfficiencyClass',
|
|
2516
|
+
description="This indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.",
|
|
2517
|
+
)
|
|
2518
|
+
epid: str | None = Field(
|
|
2519
|
+
None,
|
|
2520
|
+
description='An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.',
|
|
2521
|
+
)
|
|
2522
|
+
estimated_availabilities: list[EstimatedAvailability] | None = Field(
|
|
2523
|
+
None,
|
|
2524
|
+
alias='estimatedAvailabilities',
|
|
2525
|
+
description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.',
|
|
2526
|
+
)
|
|
2527
|
+
gender: str | None = Field(
|
|
2528
|
+
None,
|
|
2529
|
+
description='(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2530
|
+
)
|
|
2531
|
+
gtin: str | None = Field(
|
|
2532
|
+
None,
|
|
2533
|
+
description='The unique Global Trade Item number of the item as defined by https://www.gtin.info . This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.',
|
|
2534
|
+
)
|
|
2535
|
+
image: Image | None = Field(
|
|
2536
|
+
None,
|
|
2537
|
+
description='The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.',
|
|
2538
|
+
)
|
|
2539
|
+
immediate_pay: bool | None = Field(
|
|
2540
|
+
None,
|
|
2541
|
+
alias='immediatePay',
|
|
2542
|
+
description="A value of true indicates that the seller requires immediate payment from the buyer when purchasing an item. Note: It is possible for this field to be set to true , but not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyers' purchases that involve the Best Offer feature, or for offline transactions.",
|
|
2543
|
+
)
|
|
2544
|
+
inferred_epid: str | None = Field(
|
|
2545
|
+
None,
|
|
2546
|
+
alias='inferredEpid',
|
|
2547
|
+
description="The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field. Note: This field is returned only for authorized Partners.",
|
|
2548
|
+
)
|
|
2549
|
+
item_affiliate_web_url: str | None = Field(
|
|
2550
|
+
None,
|
|
2551
|
+
alias='itemAffiliateWebUrl',
|
|
2552
|
+
description='The URL to the View Item page of the item which includes the affiliate tracking ID. Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace. The itemAffiliateWebUrl is only returned if: The marketplace through which the item is being viewed is part of the eBay Partner Network.',
|
|
2553
|
+
)
|
|
2554
|
+
item_creation_date: str | None = Field(
|
|
2555
|
+
None,
|
|
2556
|
+
alias='itemCreationDate',
|
|
2557
|
+
description='A timestamp that indicates the date and time an item listing was created. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer.',
|
|
2558
|
+
)
|
|
2559
|
+
item_end_date: str | None = Field(
|
|
2560
|
+
None,
|
|
2561
|
+
alias='itemEndDate',
|
|
2562
|
+
description='A timestamp that indicates the date and time an auction listing will end. If a fixed-price listing has ended, this field indicates the date and time the listing ended. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.',
|
|
2563
|
+
)
|
|
2564
|
+
item_id: str | None = Field(
|
|
2565
|
+
None, alias='itemId', description='The unique RESTful identifier of the item.'
|
|
2566
|
+
)
|
|
2567
|
+
item_location: Address | None = Field(
|
|
2568
|
+
None, alias='itemLocation', description='The physical location of the item.'
|
|
2569
|
+
)
|
|
2570
|
+
item_web_url: str | None = Field(
|
|
2571
|
+
None,
|
|
2572
|
+
alias='itemWebUrl',
|
|
2573
|
+
description='The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.',
|
|
2574
|
+
)
|
|
2575
|
+
legacy_item_id: str | None = Field(
|
|
2576
|
+
None,
|
|
2577
|
+
alias='legacyItemId',
|
|
2578
|
+
description='The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.',
|
|
2579
|
+
)
|
|
2580
|
+
localized_aspects: list[TypedNameValue] | None = Field(
|
|
2581
|
+
None,
|
|
2582
|
+
alias='localizedAspects',
|
|
2583
|
+
description='An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.',
|
|
2584
|
+
)
|
|
2585
|
+
lot_size: int | None = Field(
|
|
2586
|
+
None,
|
|
2587
|
+
alias='lotSize',
|
|
2588
|
+
description='The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.',
|
|
2589
|
+
)
|
|
2590
|
+
marketing_price: MarketingPrice | None = Field(
|
|
2591
|
+
None,
|
|
2592
|
+
alias='marketingPrice',
|
|
2593
|
+
description='The original price and the discount amount and percentage.',
|
|
2594
|
+
)
|
|
2595
|
+
material: str | None = Field(
|
|
2596
|
+
None,
|
|
2597
|
+
description='(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2598
|
+
)
|
|
2599
|
+
minimum_price_to_bid: ConvertedAmount | None = Field(
|
|
2600
|
+
None,
|
|
2601
|
+
alias='minimumPriceToBid',
|
|
2602
|
+
description="The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding .",
|
|
2603
|
+
)
|
|
2604
|
+
mpn: str | None = Field(
|
|
2605
|
+
None,
|
|
2606
|
+
description="The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand.",
|
|
2607
|
+
)
|
|
2608
|
+
pattern: str | None = Field(
|
|
2609
|
+
None,
|
|
2610
|
+
description='(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2611
|
+
)
|
|
2612
|
+
payment_methods: list[PaymentMethod] | None = Field(
|
|
2613
|
+
None,
|
|
2614
|
+
alias='paymentMethods',
|
|
2615
|
+
description='The payment methods for the item, including the payment method types, brands, and instructions for the buyer.',
|
|
2616
|
+
)
|
|
2617
|
+
price: ConvertedAmount | None = Field(
|
|
2618
|
+
None,
|
|
2619
|
+
description='The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see the VAT-inclusive pricing.',
|
|
2620
|
+
)
|
|
2621
|
+
price_display_condition: PriceDisplayConditionEnum | None = Field(
|
|
2622
|
+
None,
|
|
2623
|
+
alias='priceDisplayCondition',
|
|
2624
|
+
description="Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.",
|
|
2625
|
+
)
|
|
2626
|
+
primary_item_group: ItemGroupSummary | None = Field(
|
|
2627
|
+
None,
|
|
2628
|
+
alias='primaryItemGroup',
|
|
2629
|
+
description='The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent".',
|
|
2630
|
+
)
|
|
2631
|
+
primary_product_review_rating: ReviewRating | None = Field(
|
|
2632
|
+
None,
|
|
2633
|
+
alias='primaryProductReviewRating',
|
|
2634
|
+
description='The container that returns the product rating details, such as review count, rating histogram, and average rating.',
|
|
2635
|
+
)
|
|
2636
|
+
priority_listing: bool | None = Field(
|
|
2637
|
+
None,
|
|
2638
|
+
alias='priorityListing',
|
|
2639
|
+
description='This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. For more information, see Promoted Listings .',
|
|
2640
|
+
)
|
|
2641
|
+
product: Product | None = Field(
|
|
2642
|
+
None,
|
|
2643
|
+
description='The container that returns the product information of the item.',
|
|
2644
|
+
)
|
|
2645
|
+
product_fiche_web_url: str | None = Field(
|
|
2646
|
+
None,
|
|
2647
|
+
alias='productFicheWebUrl',
|
|
2648
|
+
description="The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available.",
|
|
2649
|
+
)
|
|
2650
|
+
qualified_programs: list[str] | None = Field(
|
|
2651
|
+
None,
|
|
2652
|
+
alias='qualifiedPrograms',
|
|
2653
|
+
description='An array of the qualified programs available for the item, such as EBAY_PLUS , AUTHENTICITY_GUARANTEE , and AUTHENTICITY_VERIFICATION . eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.',
|
|
2654
|
+
)
|
|
2655
|
+
quantity_limit_per_buyer: int | None = Field(
|
|
2656
|
+
None,
|
|
2657
|
+
alias='quantityLimitPerBuyer',
|
|
2658
|
+
description='The maximum number for a specific item that one buyer can purchase.',
|
|
2659
|
+
)
|
|
2660
|
+
reserve_price_met: bool | None = Field(
|
|
2661
|
+
None,
|
|
2662
|
+
alias='reservePriceMet',
|
|
2663
|
+
description='This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold. Note: This is returned only for auctions that have a reserve price.',
|
|
2664
|
+
)
|
|
2665
|
+
return_terms: ItemReturnTerms | None = Field(
|
|
2666
|
+
None,
|
|
2667
|
+
alias='returnTerms',
|
|
2668
|
+
description="The container that returns an overview of the seller's return policy.",
|
|
2669
|
+
)
|
|
2670
|
+
seller: SellerDetail | None = Field(
|
|
2671
|
+
None,
|
|
2672
|
+
description='The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.',
|
|
2673
|
+
)
|
|
2674
|
+
seller_item_revision: str | None = Field(
|
|
2675
|
+
None,
|
|
2676
|
+
alias='sellerItemRevision',
|
|
2677
|
+
description='An identifier generated/incremented when a seller revises the item. There are two types of item revisions: Seller changes, such as changing the title eBay system changes, such as changing the quantity when an item is purchased This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.',
|
|
2678
|
+
)
|
|
2679
|
+
shipping_options: list[ShippingOption] | None = Field(
|
|
2680
|
+
None,
|
|
2681
|
+
alias='shippingOptions',
|
|
2682
|
+
description='An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied.',
|
|
2683
|
+
)
|
|
2684
|
+
ship_to_locations: ShipToLocations | None = Field(
|
|
2685
|
+
None,
|
|
2686
|
+
alias='shipToLocations',
|
|
2687
|
+
description='The container that returns the geographic regions to be included and excluded that define where the item can be shipped.',
|
|
2688
|
+
)
|
|
2689
|
+
short_description: str | None = Field(
|
|
2690
|
+
None,
|
|
2691
|
+
alias='shortDescription',
|
|
2692
|
+
description='This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).',
|
|
2693
|
+
)
|
|
2694
|
+
size: str | None = Field(
|
|
2695
|
+
None,
|
|
2696
|
+
description="(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container.",
|
|
2697
|
+
)
|
|
2698
|
+
size_system: str | None = Field(
|
|
2699
|
+
None,
|
|
2700
|
+
alias='sizeSystem',
|
|
2701
|
+
description='(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container. Valid Values: AU (Australia), BR (Brazil), CN (China), DE (Germany), EU (European Union), FR (France), IT (Italy), JP (Japan), MX (Mexico), US (USA), UK (United Kingdom) Code so that your app gracefully handles any future changes to this list.',
|
|
2702
|
+
)
|
|
2703
|
+
size_type: str | None = Field(
|
|
2704
|
+
None,
|
|
2705
|
+
alias='sizeType',
|
|
2706
|
+
description='(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2707
|
+
)
|
|
2708
|
+
subtitle: str | None = Field(
|
|
2709
|
+
None,
|
|
2710
|
+
description='A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results.',
|
|
2711
|
+
)
|
|
2712
|
+
taxes: list[Taxes] | None = Field(
|
|
2713
|
+
None, description='The container for the tax information for the item.'
|
|
2714
|
+
)
|
|
2715
|
+
title: str | None = Field(
|
|
2716
|
+
None,
|
|
2717
|
+
description='The seller-created title of the item. Maximum Length: 80 characters',
|
|
2718
|
+
)
|
|
2719
|
+
top_rated_buying_experience: bool | None = Field(
|
|
2720
|
+
None,
|
|
2721
|
+
alias='topRatedBuyingExperience',
|
|
2722
|
+
description='This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings.',
|
|
2723
|
+
)
|
|
2724
|
+
tyre_label_image_url: str | None = Field(
|
|
2725
|
+
None,
|
|
2726
|
+
alias='tyreLabelImageUrl',
|
|
2727
|
+
description='The URL to the image that shows the information on the tyre label.',
|
|
2728
|
+
)
|
|
2729
|
+
unique_bidder_count: int | None = Field(
|
|
2730
|
+
None,
|
|
2731
|
+
alias='uniqueBidderCount',
|
|
2732
|
+
description='This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.',
|
|
2733
|
+
)
|
|
2734
|
+
unit_price: ConvertedAmount | None = Field(
|
|
2735
|
+
None,
|
|
2736
|
+
alias='unitPrice',
|
|
2737
|
+
description='This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
|
|
2738
|
+
)
|
|
2739
|
+
unit_pricing_measure: str | None = Field(
|
|
2740
|
+
None,
|
|
2741
|
+
alias='unitPricingMeasure',
|
|
2742
|
+
description='The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
|
|
2743
|
+
)
|
|
2744
|
+
|
|
2745
|
+
|
|
2746
|
+
class Item(EbayModel):
|
|
2747
|
+
additional_images: list[Image] | None = Field(
|
|
2748
|
+
None,
|
|
2749
|
+
alias='additionalImages',
|
|
2750
|
+
description='An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.',
|
|
2751
|
+
)
|
|
2752
|
+
addon_services: list[AddonService] | None = Field(
|
|
2753
|
+
None,
|
|
2754
|
+
alias='addonServices',
|
|
2755
|
+
description='A list of add-on services that may be selected for the item or that may apply automatically.',
|
|
2756
|
+
)
|
|
2757
|
+
adult_only: bool | None = Field(
|
|
2758
|
+
None,
|
|
2759
|
+
alias='adultOnly',
|
|
2760
|
+
description='This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers.',
|
|
2761
|
+
)
|
|
2762
|
+
age_group: str | None = Field(
|
|
2763
|
+
None,
|
|
2764
|
+
alias='ageGroup',
|
|
2765
|
+
description='(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2766
|
+
)
|
|
2767
|
+
authenticity_guarantee: AuthenticityGuaranteeProgram | None = Field(
|
|
2768
|
+
None,
|
|
2769
|
+
alias='authenticityGuarantee',
|
|
2770
|
+
description='A container for information about whether an item, or the item group when returned for the getItemsByItemGroup method, is qualified for the Authenticity Guarantee program.',
|
|
2771
|
+
)
|
|
2772
|
+
authenticity_verification: AuthenticityVerificationProgram | None = Field(
|
|
2773
|
+
None,
|
|
2774
|
+
alias='authenticityVerification',
|
|
2775
|
+
description='A container for information about whether an item is from a verified seller.',
|
|
2776
|
+
)
|
|
2777
|
+
available_coupons: list[AvailableCoupon] | None = Field(
|
|
2778
|
+
None,
|
|
2779
|
+
alias='availableCoupons',
|
|
2780
|
+
description='A list of available coupons for the item. Note: The Browse API only acknowledges item-level coupons. This array will only return coupons linked with an item. Store-level coupons offered by sellers across their entire store will not be returned.',
|
|
2781
|
+
)
|
|
2782
|
+
bid_count: int | None = Field(
|
|
2783
|
+
None,
|
|
2784
|
+
alias='bidCount',
|
|
2785
|
+
description='This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.',
|
|
2786
|
+
)
|
|
2787
|
+
brand: str | None = Field(
|
|
2788
|
+
None,
|
|
2789
|
+
description='(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2790
|
+
)
|
|
2791
|
+
buying_options: list[str] | None = Field(
|
|
2792
|
+
None,
|
|
2793
|
+
alias='buyingOptions',
|
|
2794
|
+
description='A comma separated list of all the purchase options available for the item. The values returned are: FIXED_PRICE - Indicates the buyer can purchase the item for a set price using the Buy It Now button. AUCTION - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.',
|
|
2795
|
+
)
|
|
2796
|
+
category_id: str | None = Field(
|
|
2797
|
+
None,
|
|
2798
|
+
alias='categoryId',
|
|
2799
|
+
description='The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children.',
|
|
2800
|
+
)
|
|
2801
|
+
category_id_path: str | None = Field(
|
|
2802
|
+
None,
|
|
2803
|
+
alias='categoryIdPath',
|
|
2804
|
+
description='The IDs of every category in the item path, separated by pipe characters, starting with the top level parent category. For example, if an item belongs to the top level category Home and Garden (category ID 11700), followed by Home Improvement (159907), Heating, Cooling and Air (69197), and Thermostats (115947), the field would return the value: 11700|159907|69197|115947 .',
|
|
2805
|
+
)
|
|
2806
|
+
category_path: str | None = Field(
|
|
2807
|
+
None,
|
|
2808
|
+
alias='categoryPath',
|
|
2809
|
+
description='Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks',
|
|
2810
|
+
)
|
|
2811
|
+
charity_terms: ItemCharityTerms | None = Field(
|
|
2812
|
+
None,
|
|
2813
|
+
alias='charityTerms',
|
|
2814
|
+
description='This container returns any applicable charity information associated with the specified item. This container is only returned if the fieldgroups query parameter is set to CHARITY_DETAILS .',
|
|
2815
|
+
)
|
|
2816
|
+
color: str | None = Field(
|
|
2817
|
+
None,
|
|
2818
|
+
description='(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2819
|
+
)
|
|
2820
|
+
condition: str | None = Field(
|
|
2821
|
+
None,
|
|
2822
|
+
description='A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.',
|
|
2823
|
+
)
|
|
2824
|
+
condition_description: str | None = Field(
|
|
2825
|
+
None,
|
|
2826
|
+
alias='conditionDescription',
|
|
2827
|
+
description='A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item.',
|
|
2828
|
+
)
|
|
2829
|
+
condition_descriptors: list[ConditionDescriptor] | None = Field(
|
|
2830
|
+
None,
|
|
2831
|
+
alias='conditionDescriptors',
|
|
2832
|
+
description='This array is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that indicate details about a particular condition of an item.',
|
|
2833
|
+
)
|
|
2834
|
+
condition_id: str | None = Field(
|
|
2835
|
+
None,
|
|
2836
|
+
alias='conditionId',
|
|
2837
|
+
description='The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.',
|
|
2838
|
+
)
|
|
2839
|
+
current_bid_price: ConvertedAmount | None = Field(
|
|
2840
|
+
None,
|
|
2841
|
+
alias='currentBidPrice',
|
|
2842
|
+
description='The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.',
|
|
2843
|
+
)
|
|
2844
|
+
description: str | None = Field(
|
|
2845
|
+
None,
|
|
2846
|
+
description='The full description of the item that was created by the seller. This can be plain text or rich content and can be very large.',
|
|
2847
|
+
)
|
|
2848
|
+
eco_participation_fee: ConvertedAmount | None = Field(
|
|
2849
|
+
None,
|
|
2850
|
+
alias='ecoParticipationFee',
|
|
2851
|
+
description='The Eco Participation fee, a fee paid by the buyer that is applied to the cost of the eventual disposal of the purchased item. The fee is remitted in full to the eco organization. Currently, this value is required for electronic devices and furniture.',
|
|
2852
|
+
)
|
|
2853
|
+
eligible_for_inline_checkout: bool | None = Field(
|
|
2854
|
+
None,
|
|
2855
|
+
alias='eligibleForInlineCheckout',
|
|
2856
|
+
description='This field indicates if the item can be purchased using the Buy Order API . If the value of this field is true , this indicates that the item can be purchased using the Order API . If the value of this field is false , this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.',
|
|
2857
|
+
)
|
|
2858
|
+
enabled_for_guest_checkout: bool | None = Field(
|
|
2859
|
+
None,
|
|
2860
|
+
alias='enabledForGuestCheckout',
|
|
2861
|
+
description='This indicates if the item can be purchased using Guest Checkout in the Order API . You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards.',
|
|
2862
|
+
)
|
|
2863
|
+
energy_efficiency_class: str | None = Field(
|
|
2864
|
+
None,
|
|
2865
|
+
alias='energyEfficiencyClass',
|
|
2866
|
+
description="This indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.",
|
|
2867
|
+
)
|
|
2868
|
+
epid: str | None = Field(
|
|
2869
|
+
None,
|
|
2870
|
+
description='An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.',
|
|
2871
|
+
)
|
|
2872
|
+
estimated_availabilities: list[EstimatedAvailability] | None = Field(
|
|
2873
|
+
None,
|
|
2874
|
+
alias='estimatedAvailabilities',
|
|
2875
|
+
description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.',
|
|
2876
|
+
)
|
|
2877
|
+
gender: str | None = Field(
|
|
2878
|
+
None,
|
|
2879
|
+
description='(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2880
|
+
)
|
|
2881
|
+
gtin: str | None = Field(
|
|
2882
|
+
None,
|
|
2883
|
+
description='The unique Global Trade Item number of the item as defined by https://www.gtin.info . This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.',
|
|
2884
|
+
)
|
|
2885
|
+
hazardous_materials_labels: HazardousMaterialsLabels | None = Field(
|
|
2886
|
+
None,
|
|
2887
|
+
alias='hazardousMaterialsLabels',
|
|
2888
|
+
description='Hazardous materials labels for the item.',
|
|
2889
|
+
)
|
|
2890
|
+
image: Image | None = Field(
|
|
2891
|
+
None,
|
|
2892
|
+
description='The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.',
|
|
2893
|
+
)
|
|
2894
|
+
immediate_pay: bool | None = Field(
|
|
2895
|
+
None,
|
|
2896
|
+
alias='immediatePay',
|
|
2897
|
+
description='A value of true indicates that the seller requires immediate payment from the buyer when purchasing an item. Note: It is possible for this field to be set to true , but not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyers purchases that involve the Best Offer feature, or for offline transactions.',
|
|
2898
|
+
)
|
|
2899
|
+
inferred_epid: str | None = Field(
|
|
2900
|
+
None,
|
|
2901
|
+
alias='inferredEpid',
|
|
2902
|
+
description="The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field. Note: This field is returned only for authorized Partners.",
|
|
2903
|
+
)
|
|
2904
|
+
item_affiliate_web_url: str | None = Field(
|
|
2905
|
+
None,
|
|
2906
|
+
alias='itemAffiliateWebUrl',
|
|
2907
|
+
description='The URL to the View Item page of the item which includes the affiliate tracking ID. Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace. The itemAffiliateWebUrl is only returned if: The marketplace through which the item is being viewed is part of the eBay Partner Network.',
|
|
2908
|
+
)
|
|
2909
|
+
item_creation_date: str | None = Field(
|
|
2910
|
+
None,
|
|
2911
|
+
alias='itemCreationDate',
|
|
2912
|
+
description='A timestamp that indicates the date and time an item listing was created. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer.',
|
|
2913
|
+
)
|
|
2914
|
+
item_end_date: str | None = Field(
|
|
2915
|
+
None,
|
|
2916
|
+
alias='itemEndDate',
|
|
2917
|
+
description='A timestamp that indicates the date and time an auction listing will end. If a fixed-price listing has ended, this field indicates the date and time the listing ended. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.',
|
|
2918
|
+
)
|
|
2919
|
+
item_id: str | None = Field(
|
|
2920
|
+
None, alias='itemId', description='The unique RESTful identifier of the item.'
|
|
2921
|
+
)
|
|
2922
|
+
item_location: Address | None = Field(
|
|
2923
|
+
None, alias='itemLocation', description='The physical location of the item.'
|
|
2924
|
+
)
|
|
2925
|
+
item_web_url: str | None = Field(
|
|
2926
|
+
None,
|
|
2927
|
+
alias='itemWebUrl',
|
|
2928
|
+
description='The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.',
|
|
2929
|
+
)
|
|
2930
|
+
legacy_item_id: str | None = Field(
|
|
2931
|
+
None,
|
|
2932
|
+
alias='legacyItemId',
|
|
2933
|
+
description='The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.',
|
|
2934
|
+
)
|
|
2935
|
+
listing_marketplace_id: MarketplaceIdEnum | None = Field(
|
|
2936
|
+
None,
|
|
2937
|
+
alias='listingMarketplaceId',
|
|
2938
|
+
description='The ID of the eBay marketplace where the item is listed.',
|
|
2939
|
+
)
|
|
2940
|
+
localized_aspects: list[TypedNameValue] | None = Field(
|
|
2941
|
+
None,
|
|
2942
|
+
alias='localizedAspects',
|
|
2943
|
+
description='An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.',
|
|
2944
|
+
)
|
|
2945
|
+
lot_size: int | None = Field(
|
|
2946
|
+
None,
|
|
2947
|
+
alias='lotSize',
|
|
2948
|
+
description='The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.',
|
|
2949
|
+
)
|
|
2950
|
+
manufacturer: CompanyAddress | None = Field(
|
|
2951
|
+
None, description='Contact information for the manufacturer of the product.'
|
|
2952
|
+
)
|
|
2953
|
+
marketing_price: MarketingPrice | None = Field(
|
|
2954
|
+
None,
|
|
2955
|
+
alias='marketingPrice',
|
|
2956
|
+
description='The original price and the discount amount and percentage.',
|
|
2957
|
+
)
|
|
2958
|
+
material: str | None = Field(
|
|
2959
|
+
None,
|
|
2960
|
+
description='(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2961
|
+
)
|
|
2962
|
+
minimum_price_to_bid: ConvertedAmount | None = Field(
|
|
2963
|
+
None,
|
|
2964
|
+
alias='minimumPriceToBid',
|
|
2965
|
+
description="The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding .",
|
|
2966
|
+
)
|
|
2967
|
+
mpn: str | None = Field(
|
|
2968
|
+
None,
|
|
2969
|
+
description="The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand.",
|
|
2970
|
+
)
|
|
2971
|
+
pattern: str | None = Field(
|
|
2972
|
+
None,
|
|
2973
|
+
description='(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
2974
|
+
)
|
|
2975
|
+
payment_methods: list[PaymentMethod] | None = Field(
|
|
2976
|
+
None,
|
|
2977
|
+
alias='paymentMethods',
|
|
2978
|
+
description='The payment methods for the item, including the payment method types, brands, and instructions for the buyer.',
|
|
2979
|
+
)
|
|
2980
|
+
price: ConvertedAmount | None = Field(
|
|
2981
|
+
None,
|
|
2982
|
+
description='The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see the VAT-inclusive pricing.',
|
|
2983
|
+
)
|
|
2984
|
+
price_display_condition: PriceDisplayConditionEnum | None = Field(
|
|
2985
|
+
None,
|
|
2986
|
+
alias='priceDisplayCondition',
|
|
2987
|
+
description="Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.",
|
|
2988
|
+
)
|
|
2989
|
+
primary_item_group: ItemGroupSummary | None = Field(
|
|
2990
|
+
None,
|
|
2991
|
+
alias='primaryItemGroup',
|
|
2992
|
+
description='The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent".',
|
|
2993
|
+
)
|
|
2994
|
+
primary_product_review_rating: ReviewRating | None = Field(
|
|
2995
|
+
None,
|
|
2996
|
+
alias='primaryProductReviewRating',
|
|
2997
|
+
description='The container that returns the product rating details, such as review count, rating histogram, and average rating.',
|
|
2998
|
+
)
|
|
2999
|
+
priority_listing: bool | None = Field(
|
|
3000
|
+
None,
|
|
3001
|
+
alias='priorityListing',
|
|
3002
|
+
description='This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. For more information, see Promoted Listings .',
|
|
3003
|
+
)
|
|
3004
|
+
product: Product | None = Field(
|
|
3005
|
+
None,
|
|
3006
|
+
description='The container that returns the product information of the item.',
|
|
3007
|
+
)
|
|
3008
|
+
product_fiche_web_url: str | None = Field(
|
|
3009
|
+
None,
|
|
3010
|
+
alias='productFicheWebUrl',
|
|
3011
|
+
description="The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available.",
|
|
3012
|
+
)
|
|
3013
|
+
product_safety_labels: ProductSafetyLabels | None = Field(
|
|
3014
|
+
None,
|
|
3015
|
+
alias='productSafetyLabels',
|
|
3016
|
+
description='This container provides product safety labels which were provided by the seller, for the listing. The getProductSafetyLabels method of the Sell Metadata API can be used to retrieve the full set of available Product Safety pictogram labels and safety statements.',
|
|
3017
|
+
)
|
|
3018
|
+
qualified_programs: list[str] | None = Field(
|
|
3019
|
+
None,
|
|
3020
|
+
alias='qualifiedPrograms',
|
|
3021
|
+
description='An array of the qualified programs available for the item, such as EBAY_PLUS , AUTHENTICITY_GUARANTEE , and AUTHENTICITY_VERIFICATION . eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.',
|
|
3022
|
+
)
|
|
3023
|
+
quantity_limit_per_buyer: int | None = Field(
|
|
3024
|
+
None,
|
|
3025
|
+
alias='quantityLimitPerBuyer',
|
|
3026
|
+
description='The maximum number for a specific item that one buyer can purchase.',
|
|
3027
|
+
)
|
|
3028
|
+
repair_score: str | None = Field(
|
|
3029
|
+
None,
|
|
3030
|
+
alias='repairScore',
|
|
3031
|
+
description='A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place.',
|
|
3032
|
+
)
|
|
3033
|
+
reserve_price_met: bool | None = Field(
|
|
3034
|
+
None,
|
|
3035
|
+
alias='reservePriceMet',
|
|
3036
|
+
description='This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold. Note: This is returned only for auctions that have a reserve price.',
|
|
3037
|
+
)
|
|
3038
|
+
responsible_persons: list[ResponsiblePerson] | None = Field(
|
|
3039
|
+
None,
|
|
3040
|
+
alias='responsiblePersons',
|
|
3041
|
+
description='This array provides information about one or more EU-based Responsible Persons or entities associated with the listing.',
|
|
3042
|
+
)
|
|
3043
|
+
return_terms: ItemReturnTerms | None = Field(
|
|
3044
|
+
None,
|
|
3045
|
+
alias='returnTerms',
|
|
3046
|
+
description="The container that returns an overview of the seller's return policy.",
|
|
3047
|
+
)
|
|
3048
|
+
seller: SellerDetail | None = Field(
|
|
3049
|
+
None,
|
|
3050
|
+
description='The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.',
|
|
3051
|
+
)
|
|
3052
|
+
seller_custom_policies: list[SellerCustomPolicy] | None = Field(
|
|
3053
|
+
None,
|
|
3054
|
+
alias='sellerCustomPolicies',
|
|
3055
|
+
description='A list of the custom policies that are applied to a listing.',
|
|
3056
|
+
)
|
|
3057
|
+
seller_item_revision: str | None = Field(
|
|
3058
|
+
None,
|
|
3059
|
+
alias='sellerItemRevision',
|
|
3060
|
+
description='An identifier generated/incremented when a seller revises the item. There are two types of item revisions: Seller changes, such as changing the title eBay system changes, such as changing the quantity when an item is purchased This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.',
|
|
3061
|
+
)
|
|
3062
|
+
shipping_options: list[ShippingOption] | None = Field(
|
|
3063
|
+
None,
|
|
3064
|
+
alias='shippingOptions',
|
|
3065
|
+
description='An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied.',
|
|
3066
|
+
)
|
|
3067
|
+
ship_to_locations: ShipToLocations | None = Field(
|
|
3068
|
+
None,
|
|
3069
|
+
alias='shipToLocations',
|
|
3070
|
+
description='The container that returns the geographic regions to be included and excluded that define where the item can be shipped.',
|
|
3071
|
+
)
|
|
3072
|
+
short_description: str | None = Field(
|
|
3073
|
+
None,
|
|
3074
|
+
alias='shortDescription',
|
|
3075
|
+
description='This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).',
|
|
3076
|
+
)
|
|
3077
|
+
size: str | None = Field(
|
|
3078
|
+
None,
|
|
3079
|
+
description="(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container.",
|
|
3080
|
+
)
|
|
3081
|
+
size_system: str | None = Field(
|
|
3082
|
+
None,
|
|
3083
|
+
alias='sizeSystem',
|
|
3084
|
+
description='(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container. Valid Values: AU (Australia), BR (Brazil), CN (China), DE (Germany), EU (European Union), FR (France), IT (Italy), JP (Japan), MX (Mexico), US (USA), UK (United Kingdom) Code so that your app gracefully handles any future changes to this list.',
|
|
3085
|
+
)
|
|
3086
|
+
size_type: str | None = Field(
|
|
3087
|
+
None,
|
|
3088
|
+
alias='sizeType',
|
|
3089
|
+
description='(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container.',
|
|
3090
|
+
)
|
|
3091
|
+
subtitle: str | None = Field(
|
|
3092
|
+
None,
|
|
3093
|
+
description='A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results.',
|
|
3094
|
+
)
|
|
3095
|
+
taxes: list[Taxes] | None = Field(
|
|
3096
|
+
None, description='The container for the tax information for the item.'
|
|
3097
|
+
)
|
|
3098
|
+
title: str | None = Field(
|
|
3099
|
+
None,
|
|
3100
|
+
description='The seller-created title of the item. Maximum Length: 80 characters',
|
|
3101
|
+
)
|
|
3102
|
+
top_rated_buying_experience: bool | None = Field(
|
|
3103
|
+
None,
|
|
3104
|
+
alias='topRatedBuyingExperience',
|
|
3105
|
+
description='This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings.',
|
|
3106
|
+
)
|
|
3107
|
+
tyre_label_image_url: str | None = Field(
|
|
3108
|
+
None,
|
|
3109
|
+
alias='tyreLabelImageUrl',
|
|
3110
|
+
description='The URL to the image that shows the information on the tyre label.',
|
|
3111
|
+
)
|
|
3112
|
+
unique_bidder_count: int | None = Field(
|
|
3113
|
+
None,
|
|
3114
|
+
alias='uniqueBidderCount',
|
|
3115
|
+
description='This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.',
|
|
3116
|
+
)
|
|
3117
|
+
unit_price: ConvertedAmount | None = Field(
|
|
3118
|
+
None,
|
|
3119
|
+
alias='unitPrice',
|
|
3120
|
+
description='This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
|
|
3121
|
+
)
|
|
3122
|
+
unit_pricing_measure: str | None = Field(
|
|
3123
|
+
None,
|
|
3124
|
+
alias='unitPricingMeasure',
|
|
3125
|
+
description='The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
|
|
3126
|
+
)
|
|
3127
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
3128
|
+
None,
|
|
3129
|
+
description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.',
|
|
3130
|
+
)
|
|
3131
|
+
watch_count: int | None = Field(
|
|
3132
|
+
None,
|
|
3133
|
+
alias='watchCount',
|
|
3134
|
+
description='The number of users that have added the item to their watch list. Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to Watch Count data in the Browse API.',
|
|
3135
|
+
)
|
|
3136
|
+
|
|
3137
|
+
|
|
3138
|
+
class ItemGroup(EbayModel):
|
|
3139
|
+
common_descriptions: list[CommonDescriptions] | None = Field(
|
|
3140
|
+
None,
|
|
3141
|
+
alias='commonDescriptions',
|
|
3142
|
+
description='An array of containers for a description and the item IDs of all the items that have this exact description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container.',
|
|
3143
|
+
)
|
|
3144
|
+
items: list[Item] | None = Field(
|
|
3145
|
+
None,
|
|
3146
|
+
description='An array of containers for all the item variation details, excluding the description.',
|
|
3147
|
+
)
|
|
3148
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
3149
|
+
None,
|
|
3150
|
+
description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.',
|
|
3151
|
+
)
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
class Items(EbayModel):
|
|
3155
|
+
items: list[CoreItem] | None = Field(
|
|
3156
|
+
None, description='An array/list of all the items.'
|
|
3157
|
+
)
|
|
3158
|
+
total: int | None = Field(None, description='The total number of items retrieved.')
|
|
3159
|
+
warnings: list[ErrorDetailV3] | None = Field(
|
|
3160
|
+
None,
|
|
3161
|
+
description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.',
|
|
3162
|
+
)
|