-
Notifications
You must be signed in to change notification settings - Fork 755
/
Copy pathlistingsRestrictions_2021-08-01.json
571 lines (571 loc) · 18.8 KB
/
listingsRestrictions_2021-08-01.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
{
"swagger": "2.0",
"info": {
"title": "Selling Partner API for Listings Restrictions",
"description": "The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings.\n\nFor more information, see the [Listings Restrictions API Use Case Guide](doc:listings-restrictions-api-v2021-08-01-use-case-guide).",
"version": "2021-08-01",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"definitions": {
"RestrictionList": {
"description": "A list of restrictions for the specified Amazon catalog item.",
"type": "object",
"properties": {
"restrictions": {
"items": {
"$ref": "#/definitions/Restriction"
},
"type": "array"
}
},
"required": [
"restrictions"
]
},
"Restriction": {
"description": "A listing restriction, optionally qualified by a condition, with a list of reasons for the restriction.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced.",
"type": "string"
},
"conditionType": {
"description": "The condition that applies to the restriction.",
"type": "string",
"enum": [
"new_new",
"new_open_box",
"new_oem",
"refurbished_refurbished",
"used_like_new",
"used_very_good",
"used_good",
"used_acceptable",
"collectible_like_new",
"collectible_very_good",
"collectible_good",
"collectible_acceptable",
"club_club"
],
"x-docgen-enum-table-extension": [
{
"value": "new_new",
"description": "New"
},
{
"value": "new_open_box",
"description": "New - Open Box."
},
{
"value": "new_oem",
"description": "New - OEM."
},
{
"value": "refurbished_refurbished",
"description": "Refurbished"
},
{
"value": "used_like_new",
"description": "Used - Like New."
},
{
"value": "used_very_good",
"description": "Used - Very Good."
},
{
"value": "used_good",
"description": "Used - Good."
},
{
"value": "used_acceptable",
"description": "Used - Acceptable."
},
{
"value": "collectible_like_new",
"description": "Collectible - Like New."
},
{
"value": "collectible_very_good",
"description": "Collectible - Very Good."
},
{
"value": "collectible_good",
"description": "Collectible - Good."
},
{
"value": "collectible_acceptable",
"description": "Collectible - Acceptable."
},
{
"value": "club_club",
"description": "Club"
}
]
},
"reasons": {
"description": "A list of reasons for the restriction.",
"type": "array",
"items": {
"$ref": "#/definitions/Reason"
}
}
},
"required": [
"marketplaceId"
]
},
"Reason": {
"description": "A reason for the restriction, including path forward links that may allow Selling Partners to remove the restriction, if available.",
"type": "object",
"properties": {
"message": {
"description": "A message describing the reason for the restriction.",
"type": "string"
},
"reasonCode": {
"description": "A code indicating why the listing is restricted.",
"type": "string",
"enum": [
"APPROVAL_REQUIRED",
"ASIN_NOT_FOUND",
"NOT_ELIGIBLE"
],
"x-docgen-enum-table-extension": [
{
"value": "APPROVAL_REQUIRED",
"description": "Approval is required to create a listing for the specified ASIN. A path forward link will be provided that may allow Selling Partners to remove the restriction."
},
{
"value": "ASIN_NOT_FOUND",
"description": "The specified ASIN does not exist in the requested marketplace."
},
{
"value": "NOT_ELIGIBLE",
"description": "Not eligible to create a listing for the specified ASIN. No path forward link will be provided to remove the restriction."
}
]
},
"links": {
"description": "A list of path forward links that may allow Selling Partners to remove the restriction.",
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
}
},
"required": [
"message"
]
},
"Link": {
"description": "A link to resources related to a listing restriction.",
"type": "object",
"properties": {
"resource": {
"description": "The URI of the related resource.",
"type": "string",
"format": "uri"
},
"verb": {
"description": "The HTTP verb used to interact with the related resource.",
"type": "string",
"enum": [
"GET"
],
"x-docgen-enum-table-extension": [
{
"value": "GET",
"description": "The provided resource is accessed with the HTTP GET method."
}
]
},
"title": {
"description": "The title of the related resource.",
"type": "string"
},
"type": {
"description": "The media type of the related resource.",
"type": "string"
}
},
"required": [
"resource",
"verb"
]
},
"ErrorList": {
"description": "A list of error responses returned when a request is unsuccessful.",
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
},
"Error": {
"description": "Error response returned when the request is unsuccessful.",
"properties": {
"code": {
"description": "An error code that identifies the type of error that occurred.",
"type": "string"
},
"message": {
"description": "A message that describes the error condition.",
"type": "string"
},
"details": {
"description": "Additional details that can help the caller understand or fix the issue.",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
}
},
"paths": {
"/listings/2021-08-01/restrictions": {
"get": {
"tags": [
"listings"
],
"description": "Returns listing restrictions for an item in the Amazon Catalog. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getListingsRestrictions",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "asin",
"in": "query",
"description": "The Amazon Standard Identification Number (ASIN) of the item.",
"required": true,
"type": "string",
"x-example": "B0000ASIN1"
},
{
"name": "conditionType",
"in": "query",
"description": "The condition used to filter restrictions.",
"required": false,
"type": "string",
"enum": [
"new_new",
"new_open_box",
"new_oem",
"refurbished_refurbished",
"used_like_new",
"used_very_good",
"used_good",
"used_acceptable",
"collectible_like_new",
"collectible_very_good",
"collectible_good",
"collectible_acceptable",
"club_club"
],
"x-example": "used_very_good",
"x-docgen-enum-table-extension": [
{
"value": "new_new",
"description": "New"
},
{
"value": "new_open_box",
"description": "New - Open Box."
},
{
"value": "new_oem",
"description": "New - OEM."
},
{
"value": "refurbished_refurbished",
"description": "Refurbished"
},
{
"value": "used_like_new",
"description": "Used - Like New."
},
{
"value": "used_very_good",
"description": "Used - Very Good."
},
{
"value": "used_good",
"description": "Used - Good."
},
{
"value": "used_acceptable",
"description": "Used - Acceptable."
},
{
"value": "collectible_like_new",
"description": "Collectible - Like New."
},
{
"value": "collectible_very_good",
"description": "Collectible - Very Good."
},
{
"value": "collectible_good",
"description": "Collectible - Good."
},
{
"value": "collectible_acceptable",
"description": "Collectible - Acceptable."
},
{
"value": "club_club",
"description": "Club"
}
]
},
{
"name": "sellerId",
"in": "query",
"description": "A selling partner identifier, such as a merchant account.",
"required": true,
"type": "string"
},
{
"name": "marketplaceIds",
"in": "query",
"description": "A comma-delimited list of Amazon marketplace identifiers for the request.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"x-example": "ATVPDKIKX0DER"
},
{
"name": "reasonLocale",
"in": "query",
"description": "A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.",
"required": false,
"type": "string",
"x-example": "en_US"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the listings restrictions.",
"schema": {
"$ref": "#/definitions/RestrictionList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"examples": {
"application/json": {
"restrictions": [
{
"marketplaceId": "ATVPDKIKX0DER",
"conditionType": "used_acceptable",
"reasons": [
{
"message": "You cannot list the product in this condition.",
"links": [
{
"resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B0000ASIN1",
"verb": "GET",
"title": "Request Approval via Seller Central.",
"type": "text/html"
}
]
}
]
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {}
}
},
"response": {
"restrictions": [
{
"marketplaceId": "ATVPDKIKX0DER",
"conditionType": "used_acceptable",
"reasons": [
{
"message": "You cannot list the product in this condition.",
"links": [
{
"resource": "https://sellercentral.amazon.com/hz/approvalrequest/restrictions/approve?asin=B0000ASIN1",
"verb": "GET",
"title": "Request Approval via Seller Central.",
"type": "text/html"
}
]
}
]
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"asin": {
"value": "BAD_ASIN"
}
}
},
"response": [
{
"code": "BAD_REQUEST",
"message": "Invalid 'asin' provided."
}
]
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
}
}
}