-
Notifications
You must be signed in to change notification settings - Fork 726
/
fbaInventory.json
932 lines (932 loc) · 33.9 KB
/
fbaInventory.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
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
{
"swagger": "2.0",
"info": {
"description": "The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon's fulfillment network.",
"version": "v1",
"title": "Selling Partner API for FBA Inventory",
"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"
],
"paths": {
"/fba/inventory/v1/summaries": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"get": {
"tags": [
"fbaInventory"
],
"description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.\n\nUsage Plan:\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.",
"operationId": "getInventorySummaries",
"produces": [
"application/json"
],
"parameters": [
{
"name": "details",
"in": "query",
"description": "true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "granularityType",
"in": "query",
"description": "The granularity type for the inventory aggregation level.",
"required": true,
"type": "string",
"enum": [
"Marketplace"
],
"x-docgen-enum-table-extension": [
{
"value": "Marketplace",
"description": "Marketplace"
}
]
},
{
"name": "granularityId",
"in": "query",
"description": "The granularity ID for the inventory aggregation level.",
"required": true,
"type": "string"
},
{
"name": "startDateTime",
"in": "query",
"description": "A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "sellerSkus",
"in": "query",
"description": "A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50
},
{
"name": "sellerSku",
"in": "query",
"description": "A single seller SKU used for querying the specified seller SKU inventory summaries.",
"required": false,
"type": "string"
},
{
"name": "nextToken",
"in": "query",
"description": "String token returned in the response of your previous request. The string token will expire 30 seconds after being created.",
"required": false,
"type": "string"
},
{
"name": "marketplaceIds",
"in": "query",
"description": "The marketplace ID for the marketplace for which to return inventory summaries.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inventory/v1/items": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true,
"post": {
"tags": [
"fbaInventory"
],
"description": "Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "createInventoryItem",
"produces": [
"application/json"
],
"parameters": [
{
"name": "createInventoryItemRequestBody",
"in": "body",
"description": "CreateInventoryItem Request Body Parameter.",
"required": true,
"schema": {
"$ref": "#/definitions/CreateInventoryItemRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inventory/v1/items/{sellerSku}": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true,
"delete": {
"tags": [
"fbaInventory"
],
"description": "Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "deleteInventoryItem",
"produces": [
"application/json"
],
"parameters": [
{
"name": "sellerSku",
"in": "path",
"description": "A single seller SKU used for querying the specified seller SKU inventory summaries.",
"required": true,
"type": "string"
},
{
"name": "marketplaceId",
"in": "query",
"description": "The marketplace ID for the marketplace for which the sellerSku is to be deleted.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inventory/v1/items/inventory": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true,
"post": {
"tags": [
"fbaInventory"
],
"description": "Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "addInventory",
"produces": [
"application/json"
],
"parameters": [
{
"name": "x-amzn-idempotency-token",
"in": "header",
"description": "A unique token/requestId provided with each call to ensure idempotency.",
"required": true,
"type": "string"
},
{
"name": "addInventoryRequestBody",
"in": "body",
"description": "List of items to add to Sandbox inventory.",
"required": true,
"schema": {
"$ref": "#/definitions/AddInventoryRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
}
},
"definitions": {
"CreateInventoryItemRequest": {
"description": "An item to be created in the inventory.",
"type": "object",
"properties": {
"sellerSku" : {
"description": "The seller SKU of the item.",
"type": "string"
},
"marketplaceId" : {
"description": "The marketplaceId.",
"type": "string"
},
"productName": {
"description": "The name of the item.",
"type": "string"
}
},
"required": ["sellerSku", "marketplaceId", "productName"]
},
"AddInventoryRequest": {
"description": "The object with the list of Inventory to be added",
"type": "object",
"properties": {
"inventoryItems": {
"$ref": "#/definitions/InventoryItems"
}
}
},
"InventoryItems": {
"description": "List of Inventory to be added",
"type": "array",
"items": {
"$ref": "#/definitions/InventoryItem"
}
},
"InventoryItem": {
"description": "An item in the list of inventory to be added.",
"type": "object",
"properties": {
"sellerSku" : {
"description": "The seller SKU of the item.",
"type": "string"
},
"marketplaceId" : {
"description": "The marketplaceId.",
"type": "string"
},
"quantity": {
"description": "The quantity of item to add.",
"type": "integer"
}
},
"required": ["sellerSku", "marketplaceId", "quantity"]
},
"CreateInventoryItemResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the CreateInventoryItem operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the CreateInventoryItem operation."
},
"DeleteInventoryItemResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the DeleteInventoryItem operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the DeleteInventoryItem operation."
},
"AddInventoryResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the AddInventory operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the AddInventory operation."
},
"Granularity": {
"type": "object",
"properties": {
"granularityType": {
"type": "string",
"description": "The granularity type for the inventory aggregation level.",
"x-docgen-enum-table-extension": [
{
"value": "Marketplace",
"description": "Marketplace"
}
]
},
"granularityId": {
"type": "string",
"description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId."
}
},
"description": "Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace."
},
"ReservedQuantity": {
"type": "object",
"properties": {
"totalReservedQuantity": {
"type": "integer",
"description": "The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes."
},
"pendingCustomerOrderQuantity": {
"type": "integer",
"description": "The number of units reserved for customer orders."
},
"pendingTransshipmentQuantity": {
"type": "integer",
"description": "The number of units being transferred from one fulfillment center to another."
},
"fcProcessingQuantity": {
"type": "integer",
"description": "The number of units that have been sidelined at the fulfillment center for additional processing."
}
},
"description": "The quantity of reserved inventory."
},
"ResearchingQuantityEntry": {
"type": "object",
"required": [
"name",
"quantity"
],
"properties": {
"name": {
"type": "string",
"description": "The duration of the research.",
"enum": [
"researchingQuantityInShortTerm",
"researchingQuantityInMidTerm",
"researchingQuantityInLongTerm"
],
"x-docgen-enum-table-extension": [
{
"value": "researchingQuantityInShortTerm",
"description": "Short Term for 1-10 days."
},
{
"value": "researchingQuantityInMidTerm",
"description": "Mid Term for 11-20 days."
},
{
"value": "researchingQuantityInLongTerm",
"description": "Long Term for 21 days or longer."
}
]
},
"quantity": {
"type": "integer",
"description": "The number of units."
}
},
"description": "The misplaced or warehouse damaged inventory that is actively being confirmed at our fulfillment centers."
},
"ResearchingQuantity": {
"type": "object",
"properties": {
"totalResearchingQuantity": {
"type": "integer",
"description": "The total number of units currently being researched in Amazon's fulfillment network."
},
"researchingQuantityBreakdown": {
"type": "array",
"description": "A list of quantity details for items currently being researched.",
"items": {
"$ref": "#/definitions/ResearchingQuantityEntry"
}
}
},
"description": "The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers."
},
"UnfulfillableQuantity": {
"type": "object",
"properties": {
"totalUnfulfillableQuantity": {
"type": "integer",
"description": "The total number of units in Amazon's fulfillment network in unsellable condition."
},
"customerDamagedQuantity": {
"type": "integer",
"description": "The number of units in customer damaged disposition."
},
"warehouseDamagedQuantity": {
"type": "integer",
"description": "The number of units in warehouse damaged disposition."
},
"distributorDamagedQuantity": {
"type": "integer",
"description": "The number of units in distributor damaged disposition."
},
"carrierDamagedQuantity": {
"type": "integer",
"description": "The number of units in carrier damaged disposition."
},
"defectiveQuantity": {
"type": "integer",
"description": "The number of units in defective disposition."
},
"expiredQuantity": {
"type": "integer",
"description": "The number of units in expired disposition."
}
},
"description": "The quantity of unfulfillable inventory."
},
"InventoryDetails": {
"type": "object",
"properties": {
"fulfillableQuantity": {
"type": "integer",
"description": "The item quantity that can be picked, packed, and shipped."
},
"inboundWorkingQuantity": {
"type": "integer",
"description": "The number of units in an inbound shipment for which you have notified Amazon."
},
"inboundShippedQuantity": {
"type": "integer",
"description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number."
},
"inboundReceivingQuantity": {
"type": "integer",
"description": "The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed."
},
"reservedQuantity": {
"$ref": "#/definitions/ReservedQuantity"
},
"researchingQuantity": {
"$ref": "#/definitions/ResearchingQuantity"
},
"unfulfillableQuantity": {
"$ref": "#/definitions/UnfulfillableQuantity"
}
},
"description": "Summarized inventory details. This object will not appear if the details parameter in the request is false."
},
"InventorySummary": {
"type": "object",
"properties": {
"asin": {
"type": "string",
"description": "The Amazon Standard Identification Number (ASIN) of an item."
},
"fnSku": {
"type": "string",
"description": "Amazon's fulfillment network SKU identifier."
},
"sellerSku": {
"type": "string",
"description": "The seller SKU of the item."
},
"condition": {
"type": "string",
"description": "The condition of the item as described by the seller (for example, New Item)."
},
"inventoryDetails": {
"$ref": "#/definitions/InventoryDetails"
},
"lastUpdatedTime": {
"type": "string",
"format": "date-time",
"description": "The date and time that any quantity was last updated."
},
"productName": {
"type": "string",
"description": "The localized language product title of the item within the specific marketplace."
},
"totalQuantity": {
"type": "integer",
"description": "The total number of units in an inbound shipment or in Amazon fulfillment centers."
}
},
"description": "Inventory summary for a specific item."
},
"InventorySummaries": {
"type": "array",
"description": "A list of inventory summaries.",
"items": {
"$ref": "#/definitions/InventorySummary"
}
},
"Pagination": {
"type": "object",
"properties": {
"nextToken": {
"type": "string",
"description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return."
}
},
"description": "The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management."
},
"GetInventorySummariesResult": {
"type": "object",
"required": [
"granularity",
"inventorySummaries"
],
"properties": {
"granularity": {
"$ref": "#/definitions/Granularity"
},
"inventorySummaries": {
"$ref": "#/definitions/InventorySummaries"
}
},
"description": "The payload schema for the getInventorySummaries operation."
},
"GetInventorySummariesResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getInventorySummaries operation.",
"$ref": "#/definitions/GetInventorySummariesResult"
},
"pagination": {
"$ref": "#/definitions/Pagination"
},
"errors": {
"description": "One or more unexpected errors occurred during the getInventorySummaries operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The Response schema."
},
"Error": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occurred."
},
"message": {
"type": "string",
"description": "A message that describes the error condition in a human-readable form."
},
"details": {
"type": "string",
"description": "Additional information that can help the caller understand or fix the issue."
}
},
"description": "An error response returned when the request is unsuccessful."
},
"ErrorList": {
"type": "array",
"description": "A list of error responses returned when a request is unsuccessful.",
"items": {
"$ref": "#/definitions/Error"
}
}
}
}